57fd3ab536ff8b6c80ebbec4423689d49fb7ddf1
2 * TableSorter for MediaWiki
4 * Written 2011 Leo Koppelkamm
5 * Based on tablesorter.com plugin, written (c) 2007 Christian Bach.
7 * Dual licensed under the MIT and GPL licenses:
8 * http://www.opensource.org/licenses/mit-license.php
9 * http://www.gnu.org/licenses/gpl.html
11 * Depends on mw.config (wgDigitTransformTable, wgDefaultDateFormat, wgPageContentLanguage)
12 * and mw.language.months.
14 * Uses 'tableSorterCollation' in mw.config (if available)
16 * Create a sortable table with multi-column sorting capabilities
18 * // Create a simple tablesorter interface
19 * $( 'table' ).tablesorter();
21 * // Create a tablesorter interface, initially sorting on the first and second column
22 * $( 'table' ).tablesorter( { sortList: [ { 0: 'desc' }, { 1: 'asc' } ] } );
24 * @param {string} [cssHeader="header"] A string of the class name to be appended to sortable
25 * tr elements in the thead of the table.
27 * @param {string} [cssAsc="headerSortUp"] A string of the class name to be appended to
28 * sortable tr elements in the thead on a ascending sort.
30 * @param {string} [cssDesc="headerSortDown"] A string of the class name to be appended to
31 * sortable tr elements in the thead on a descending sort.
33 * @param {string} [sortMultisortKey="shiftKey"] A string of the multi-column sort key.
35 * @param {boolean} [cancelSelection=true] Boolean flag indicating iftablesorter should cancel
36 * selection of the table headers text.
38 * @param {Array} [sortList] An array containing objects specifying sorting. By passing more
39 * than one object, multi-sorting will be applied. Object structure:
40 * { <Integer column index>: <String 'asc' or 'desc'> }
42 * @event sortEnd.tablesorter: Triggered as soon as any sorting has been applied.
44 * @author Christian Bach/christian.bach@polyester.se
50 /* Parser utility functions */
52 function getParserById( name
) {
54 for ( i
= 0; i
< parsers
.length
; i
++ ) {
55 if ( parsers
[ i
].id
.toLowerCase() === name
.toLowerCase() ) {
62 function getElementSortKey( node
) {
63 var $node
= $( node
),
64 // Use data-sort-value attribute.
65 // Use data() instead of attr() so that live value changes
66 // are processed as well (T40152).
67 data
= $node
.data( 'sortValue' );
69 if ( data
!== null && data
!== undefined ) {
70 // Cast any numbers or other stuff to a string, methods
71 // like charAt, toLowerCase and split are expected.
72 return String( data
);
77 if ( node
.tagName
.toLowerCase() === 'img' ) {
78 return $node
.attr( 'alt' ) || ''; // handle undefined alt
80 return $.makeArray( node
.childNodes
).map( function ( elem
) {
81 if ( elem
.nodeType
=== Node
.ELEMENT_NODE
) {
82 if ( $( elem
).hasClass( 'reference' ) ) {
85 return getElementSortKey( elem
);
88 return $.text( elem
);
92 function detectParserForColumn( table
, rows
, column
) {
93 var l
= parsers
.length
,
94 config
= $( table
).data( 'tablesorter' ).config
,
98 // Start with 1 because 0 is the fallback parser
104 needed
= ( rows
.length
> 4 ) ? 5 : rows
.length
;
107 // if this is a child row, continue to the next row (as buildCache())
108 if ( rows
[ rowIndex
] && !$( rows
[ rowIndex
] ).hasClass( config
.cssChildRow
) ) {
109 if ( rowIndex
!== lastRowIndex
) {
110 lastRowIndex
= rowIndex
;
111 cellIndex
= $( rows
[ rowIndex
] ).data( 'columnToCell' )[ column
];
112 nodeValue
= getElementSortKey( rows
[ rowIndex
].cells
[ cellIndex
] ).trim();
118 if ( nodeValue
!== '' ) {
119 if ( parsers
[ i
].is( nodeValue
, table
) ) {
122 if ( concurrent
>= needed
) {
123 // Confirmed the parser for multiple cells, let's return it
126 } else if ( parsers
[ i
].id
.match( /isoDate/ ) && /^\D*(\d{1,4}) ?(\[.+\])?$/.test( nodeValue
) ) {
127 // For 1-4 digits and maybe reference(s) parser "isoDate" or "number" is possible, check next row
131 // Check next parser, reset rows
147 if ( rowIndex
>= rows
.length
) {
148 if ( concurrent
> 0 && concurrent
>= rows
.length
- empty
) {
149 // Confirmed the parser for all filled cells
152 // Check next parser, reset rows
161 // 0 is always the generic parser (text)
165 function buildParserCache( table
, $headers
) {
166 var sortType
, len
, j
, parser
,
167 rows
= table
.tBodies
[ 0 ].rows
,
168 config
= $( table
).data( 'tablesorter' ).config
,
172 len
= config
.columns
;
173 for ( j
= 0; j
< len
; j
++ ) {
175 sortType
= $headers
.eq( config
.columnToHeader
[ j
] ).data( 'sortType' );
176 if ( sortType
!== undefined ) {
177 parser
= getParserById( sortType
);
180 if ( parser
=== false ) {
181 parser
= detectParserForColumn( table
, rows
, j
);
184 parsers
.push( parser
);
190 /* Other utility functions */
192 function buildCache( table
) {
193 var i
, j
, $row
, cols
,
194 totalRows
= ( table
.tBodies
[ 0 ] && table
.tBodies
[ 0 ].rows
.length
) || 0,
195 config
= $( table
).data( 'tablesorter' ).config
,
196 parsers
= config
.parsers
,
197 len
= parsers
.length
,
204 for ( i
= 0; i
< totalRows
; i
++ ) {
206 // Add the table data to main data array
207 $row
= $( table
.tBodies
[ 0 ].rows
[ i
] );
210 // if this is a child row, add it to the last row's children and
211 // continue to the next row
212 if ( $row
.hasClass( config
.cssChildRow
) ) {
213 cache
.row
[ cache
.row
.length
- 1 ] = cache
.row
[ cache
.row
.length
- 1 ].add( $row
);
214 // go to the next for loop
218 cache
.row
.push( $row
);
220 for ( j
= 0; j
< len
; j
++ ) {
221 cellIndex
= $row
.data( 'columnToCell' )[ j
];
222 cols
.push( parsers
[ j
].format( getElementSortKey( $row
[ 0 ].cells
[ cellIndex
] ) ) );
225 cols
.push( cache
.normalized
.length
); // add position for rowCache
226 cache
.normalized
.push( cols
);
233 function appendToTable( table
, cache
) {
236 normalized
= cache
.normalized
,
237 totalRows
= normalized
.length
,
238 checkCell
= ( normalized
[ 0 ].length
- 1 ),
239 fragment
= document
.createDocumentFragment();
241 for ( i
= 0; i
< totalRows
; i
++ ) {
242 pos
= normalized
[ i
][ checkCell
];
244 l
= row
[ pos
].length
;
245 for ( j
= 0; j
< l
; j
++ ) {
246 fragment
.appendChild( row
[ pos
][ j
] );
250 table
.tBodies
[ 0 ].appendChild( fragment
);
252 $( table
).trigger( 'sortEnd.tablesorter' );
256 * Find all header rows in a thead-less table and put them in a <thead> tag.
257 * This only treats a row as a header row if it contains only <th>s (no <td>s)
258 * and if it is preceded entirely by header rows. The algorithm stops when
259 * it encounters the first non-header row.
261 * After this, it will look at all rows at the bottom for footer rows
262 * And place these in a tfoot using similar rules.
264 * @param {jQuery} $table object for a <table>
266 function emulateTHeadAndFoot( $table
) {
267 var $thead
, $tfoot
, i
, len
,
268 $rows
= $table
.find( '> tbody > tr' );
269 if ( !$table
.get( 0 ).tHead
) {
270 $thead
= $( '<thead>' );
271 $rows
.each( function () {
272 if ( $( this ).children( 'td' ).length
) {
273 // This row contains a <td>, so it's not a header row
277 $thead
.append( this );
279 $table
.find( ' > tbody:first' ).before( $thead
);
281 if ( !$table
.get( 0 ).tFoot
) {
282 $tfoot
= $( '<tfoot>' );
284 for ( i
= len
- 1; i
>= 0; i
-- ) {
285 if ( $( $rows
[ i
] ).children( 'td' ).length
) {
288 $tfoot
.prepend( $( $rows
[ i
] ) );
290 $table
.append( $tfoot
);
294 function uniqueElements( array
) {
296 array
.forEach( function ( elem
) {
297 if ( elem
!== undefined && uniques
.indexOf( elem
) === -1 ) {
298 uniques
.push( elem
);
304 function buildHeaders( table
, msg
) {
305 var config
= $( table
).data( 'tablesorter' ).config
,
317 $tableHeaders
= $( [] ),
318 $tableRows
= $( 'thead:eq(0) > tr', table
);
320 if ( $tableRows
.length
<= 1 ) {
321 $tableHeaders
= $tableRows
.children( 'th' );
325 // Loop through all the dom cells of the thead
326 $tableRows
.each( function ( rowIndex
, row
) {
327 // eslint-disable-next-line jquery/no-each-util
328 $.each( row
.cells
, function ( columnIndex
, cell
) {
332 rowspan
= Number( cell
.rowSpan
);
333 colspan
= Number( cell
.colSpan
);
335 // Skip the spots in the exploded matrix that are already filled
336 while ( exploded
[ rowIndex
] && exploded
[ rowIndex
][ columnIndex
] !== undefined ) {
340 // Find the actual dimensions of the thead, by placing each cell
341 // in the exploded matrix rowspan times colspan times, with the proper offsets
342 for ( matrixColumnIndex
= columnIndex
; matrixColumnIndex
< columnIndex
+ colspan
; ++matrixColumnIndex
) {
343 for ( matrixRowIndex
= rowIndex
; matrixRowIndex
< rowIndex
+ rowspan
; ++matrixRowIndex
) {
344 if ( !exploded
[ matrixRowIndex
] ) {
345 exploded
[ matrixRowIndex
] = [];
347 exploded
[ matrixRowIndex
][ matrixColumnIndex
] = cell
;
352 // We want to find the row that has the most columns (ignoring colspan)
353 exploded
.forEach( function ( cellArray
, index
) {
354 headerCount
= $( uniqueElements( cellArray
) ).filter( 'th' ).length
;
355 if ( headerCount
>= maxSeen
) {
356 maxSeen
= headerCount
;
360 // We cannot use $.unique() here because it sorts into dom order, which is undesirable
361 $tableHeaders
= $( uniqueElements( exploded
[ longestTR
] ) ).filter( 'th' );
364 // as each header can span over multiple columns (using colspan=N),
365 // we have to bidirectionally map headers to their columns and columns to their headers
366 config
.columnToHeader
= [];
367 config
.headerToColumns
= [];
368 config
.headerList
= [];
370 $tableHeaders
.each( function () {
374 if ( !$cell
.hasClass( config
.unsortableClass
) ) {
376 .addClass( config
.cssHeader
)
377 .prop( 'tabIndex', 0 )
379 role
: 'columnheader button',
383 for ( k
= 0; k
< this.colSpan
; k
++ ) {
384 config
.columnToHeader
[ colspanOffset
+ k
] = headerIndex
;
385 columns
.push( colspanOffset
+ k
);
388 config
.headerToColumns
[ headerIndex
] = columns
;
391 headerIndex
: headerIndex
,
396 // add only sortable cells to headerList
397 config
.headerList
[ headerIndex
] = this;
401 colspanOffset
+= this.colSpan
;
404 // number of columns with extended colspan, inclusive unsortable
405 // parsers[j], cache[][j], columnToHeader[j], columnToCell[j] have so many elements
406 config
.columns
= colspanOffset
;
408 return $tableHeaders
.not( '.' + config
.unsortableClass
);
411 function isValueInArray( v
, a
) {
413 for ( i
= 0; i
< a
.length
; i
++ ) {
414 if ( a
[ i
][ 0 ] === v
) {
422 * Sets the sort count of the columns that are not affected by the sorting to have them sorted
423 * in default (ascending) order when their header cell is clicked the next time.
425 * @param {jQuery} $headers
426 * @param {Array} sortList 2D number array
427 * @param {Array} headerToColumns 2D number array
429 function setHeadersOrder( $headers
, sortList
, headerToColumns
) {
430 // Loop through all headers to retrieve the indices of the columns the header spans across:
431 headerToColumns
.forEach( function ( columns
, headerIndex
) {
433 columns
.forEach( function ( columnIndex
, i
) {
435 header
= $headers
[ headerIndex
],
436 $header
= $( header
);
438 if ( !isValueInArray( columnIndex
, sortList
) ) {
439 // Column shall not be sorted: Reset header count and order.
445 // Column shall be sorted: Apply designated count and order.
446 for ( j
= 0; j
< sortList
.length
; j
++ ) {
447 sortColumn
= sortList
[ j
];
448 if ( sortColumn
[ 0 ] === i
) {
450 order
: sortColumn
[ 1 ],
451 count
: sortColumn
[ 1 ] + 1
462 function setHeadersCss( table
, $headers
, list
, css
, msg
, columnToHeader
) {
464 // Remove all header information and reset titles to default message
465 $headers
.removeClass( css
).attr( 'title', msg
[ 1 ] );
467 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
469 .eq( columnToHeader
[ list
[ i
][ 0 ] ] )
470 .addClass( css
[ list
[ i
][ 1 ] ] )
471 .attr( 'title', msg
[ list
[ i
][ 1 ] ] );
475 function sortText( a
, b
) {
476 return ( ( a
< b
) ? -1 : ( ( a
> b
) ? 1 : 0 ) );
479 function sortTextDesc( a
, b
) {
480 return ( ( b
< a
) ? -1 : ( ( b
> a
) ? 1 : 0 ) );
483 function multisort( table
, sortList
, cache
) {
487 for ( i
= 0; i
< sortList
.length
; i
++ ) {
488 sortFn
[ i
] = ( sortList
[ i
][ 1 ] ) ? sortTextDesc
: sortText
;
490 cache
.normalized
.sort( function ( array1
, array2
) {
492 for ( i
= 0; i
< sortList
.length
; i
++ ) {
493 col
= sortList
[ i
][ 0 ];
494 ret
= sortFn
[ i
].call( this, array1
[ col
], array2
[ col
] );
499 // Fall back to index number column to ensure stable sort
500 return sortText
.call( this, array1
[ array1
.length
- 1 ], array2
[ array2
.length
- 1 ] );
505 function buildTransformTable() {
506 var ascii
, localised
, i
, digitClass
,
507 digits
= '0123456789,.'.split( '' ),
508 separatorTransformTable
= mw
.config
.get( 'wgSeparatorTransformTable' ),
509 digitTransformTable
= mw
.config
.get( 'wgDigitTransformTable' );
511 if ( separatorTransformTable
=== null || ( separatorTransformTable
[ 0 ] === '' && digitTransformTable
[ 2 ] === '' ) ) {
512 ts
.transformTable
= false;
514 ts
.transformTable
= {};
516 // Unpack the transform table
517 ascii
= separatorTransformTable
[ 0 ].split( '\t' ).concat( digitTransformTable
[ 0 ].split( '\t' ) );
518 localised
= separatorTransformTable
[ 1 ].split( '\t' ).concat( digitTransformTable
[ 1 ].split( '\t' ) );
520 // Construct regexes for number identification
521 for ( i
= 0; i
< ascii
.length
; i
++ ) {
522 ts
.transformTable
[ localised
[ i
] ] = ascii
[ i
];
523 digits
.push( mw
.RegExp
.escape( localised
[ i
] ) );
526 digitClass
= '[' + digits
.join( '', digits
) + ']';
528 // We allow a trailing percent sign, which we just strip. This works fine
529 // if percents and regular numbers aren't being mixed.
530 ts
.numberRegex
= new RegExp(
532 '[-+\u2212]?[0-9][0-9,]*(\\.[0-9,]*)?(E[-+\u2212]?[0-9][0-9,]*)?' + // Fortran-style scientific
534 '[-+\u2212]?' + digitClass
+ '+[\\s\\xa0]*%?' + // Generic localised
540 function buildDateTable() {
546 for ( i
= 0; i
< 12; i
++ ) {
547 name
= mw
.language
.months
.names
[ i
].toLowerCase();
548 ts
.monthNames
[ name
] = i
+ 1;
549 regex
.push( mw
.RegExp
.escape( name
) );
550 name
= mw
.language
.months
.genitive
[ i
].toLowerCase();
551 ts
.monthNames
[ name
] = i
+ 1;
552 regex
.push( mw
.RegExp
.escape( name
) );
553 name
= mw
.language
.months
.abbrev
[ i
].toLowerCase().replace( '.', '' );
554 ts
.monthNames
[ name
] = i
+ 1;
555 regex
.push( mw
.RegExp
.escape( name
) );
558 // Build piped string
559 regex
= regex
.join( '|' );
562 // Any date formated with . , ' - or /
563 ts
.dateRegex
[ 0 ] = new RegExp( /^\s*(\d{1,2})[,.\-/'\s]{1,2}(\d{1,2})[,.\-/'\s
]{1,2}(\d
{2,4})\s
*?/i
);
565 // Written Month name, dmy
566 ts
.dateRegex
[ 1 ] = new RegExp(
567 '^\\s*(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(' +
570 '[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$',
574 // Written Month name, mdy
575 ts
.dateRegex
[ 2 ] = new RegExp(
576 '^\\s*(' + regex
+ ')' +
577 '[\\,\\.\\-\\/\'\\s]+(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$',
584 * Replace all rowspanned cells in the body with clones in each row, so sorting
585 * need not worry about them.
587 * @param {jQuery} $table jQuery object for a <table>
589 function explodeRowspans( $table
) {
590 var spanningRealCellIndex
, rowSpan
, colSpan
,
591 cell
, cellData
, i
, $tds
, $clone
, $nextRows
,
592 rowspanCells
= $table
.find( '> tbody > tr > [rowspan]' ).get();
595 if ( !rowspanCells
.length
) {
599 // First, we need to make a property like cellIndex but taking into
600 // account colspans. We also cache the rowIndex to avoid having to take
601 // cell.parentNode.rowIndex in the sorting function below.
602 $table
.find( '> tbody > tr' ).each( function () {
605 len
= this.cells
.length
;
606 for ( i
= 0; i
< len
; i
++ ) {
607 $( this.cells
[ i
] ).data( 'tablesorter', {
609 realRowIndex
: this.rowIndex
611 col
+= this.cells
[ i
].colSpan
;
615 // Split multi row cells into multiple cells with the same content.
616 // Sort by column then row index to avoid problems with odd table structures.
617 // Re-sort whenever a rowspanned cell's realCellIndex is changed, because it
618 // might change the sort order.
619 function resortCells() {
623 rowspanCells
= rowspanCells
.sort( function ( a
, b
) {
624 cellAData
= $.data( a
, 'tablesorter' );
625 cellBData
= $.data( b
, 'tablesorter' );
626 ret
= cellAData
.realCellIndex
- cellBData
.realCellIndex
;
628 ret
= cellAData
.realRowIndex
- cellBData
.realRowIndex
;
632 rowspanCells
.forEach( function ( cell
) {
633 $.data( cell
, 'tablesorter' ).needResort
= false;
638 function filterfunc() {
639 return $.data( this, 'tablesorter' ).realCellIndex
>= spanningRealCellIndex
;
642 function fixTdCellIndex() {
643 $.data( this, 'tablesorter' ).realCellIndex
+= colSpan
;
644 if ( this.rowSpan
> 1 ) {
645 $.data( this, 'tablesorter' ).needResort
= true;
649 while ( rowspanCells
.length
) {
650 if ( $.data( rowspanCells
[ 0 ], 'tablesorter' ).needResort
) {
654 cell
= rowspanCells
.shift();
655 cellData
= $.data( cell
, 'tablesorter' );
656 rowSpan
= cell
.rowSpan
;
657 colSpan
= cell
.colSpan
;
658 spanningRealCellIndex
= cellData
.realCellIndex
;
660 $nextRows
= $( cell
).parent().nextAll();
661 for ( i
= 0; i
< rowSpan
- 1; i
++ ) {
662 $tds
= $( $nextRows
[ i
].cells
).filter( filterfunc
);
663 $clone
= $( cell
).clone();
664 $clone
.data( 'tablesorter', {
665 realCellIndex
: spanningRealCellIndex
,
666 realRowIndex
: cellData
.realRowIndex
+ i
,
670 $tds
.each( fixTdCellIndex
);
671 $tds
.first().before( $clone
);
673 $nextRows
.eq( i
).append( $clone
);
680 * Build index to handle colspanned cells in the body.
681 * Set the cell index for each column in an array,
682 * so that colspaned cells set multiple in this array.
683 * columnToCell[collumnIndex] point at the real cell in this row.
685 * @param {jQuery} $table object for a <table>
687 function manageColspans( $table
) {
689 $rows
= $table
.find( '> tbody > tr' ),
690 totalRows
= $rows
.length
|| 0,
691 config
= $table
.data( 'tablesorter' ).config
,
692 columns
= config
.columns
,
693 columnToCell
, cellsInRow
, index
;
695 for ( i
= 0; i
< totalRows
; i
++ ) {
697 $row
= $rows
.eq( i
);
698 // if this is a child row, continue to the next row (as buildCache())
699 if ( $row
.hasClass( config
.cssChildRow
) ) {
700 // go to the next for loop
705 cellsInRow
= ( $row
[ 0 ].cells
.length
) || 0; // all cells in this row
706 index
= 0; // real cell index in this row
707 for ( j
= 0; j
< columns
; index
++ ) {
708 if ( index
=== cellsInRow
) {
709 // Row with cells less than columns: add empty cell
710 $row
.append( '<td>' );
713 for ( k
= 0; k
< $row
[ 0 ].cells
[ index
].colSpan
; k
++ ) {
714 columnToCell
[ j
++ ] = index
;
718 $row
.data( 'columnToCell', columnToCell
);
722 function buildCollationTable() {
724 ts
.collationTable
= mw
.config
.get( 'tableSorterCollation' );
725 ts
.collationRegex
= null;
726 if ( ts
.collationTable
) {
727 // Build array of key names
728 for ( key
in ts
.collationTable
) {
729 keys
.push( mw
.RegExp
.escape( key
) );
732 ts
.collationRegex
= new RegExp( keys
.join( '|' ), 'ig' );
737 function cacheRegexs() {
743 new RegExp( /^\d{1,3}[.]\d{1,3}[.]\d{1,3}[.]\d{1,3}$/ )
746 new RegExp( /(^[£$€¥]|[£$€¥]$)/ ),
747 new RegExp( /[£$€¥]/g )
750 new RegExp( /^(https?|ftp|file):\/\/$/ ),
751 new RegExp( /(https?|ftp|file):\/\// )
754 new RegExp( /^[^-\d]*(-?\d{1,4})-(0\d|1[0-2])(-([0-3]\d))?([T\s]([01]\d|2[0-4]):?(([0-5]\d):?(([0-5]\d|60)([.,]\d{1,3})?)?)?([zZ]|([-+])([01]\d|2[0-3]):?([0-5]\d)?)?)?/ ),
755 new RegExp( /^[^-\d]*(-?\d{1,4})-?(\d\d)?(-?(\d\d))?([T\s](\d\d):?((\d\d)?:?((\d\d)?([.,]\d{1,3})?)?)?([zZ]|([-+])(\d\d):?(\d\d)?)?)?/ )
758 new RegExp( /^[A-Za-z]{3,10}\.? [0-9]{1,2}, ([0-9]{4}|'?[0-9]{2}) (([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(AM|PM)))$/ )
761 new RegExp( /^(([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(am|pm)))$/ )
767 * Converts sort objects [ { Integer: String }, ... ] to the internally used nested array
768 * structure [ [ Integer, Integer ], ... ]
770 * @param {Array} sortObjects List of sort objects.
771 * @return {Array} List of internal sort definitions.
773 function convertSortList( sortObjects
) {
775 sortObjects
.forEach( function ( sortObject
) {
776 // eslint-disable-next-line jquery/no-each-util
777 $.each( sortObject
, function ( columnIndex
, order
) {
778 var orderIndex
= ( order
=== 'desc' ) ? 1 : 0;
779 sortList
.push( [ parseInt( columnIndex
, 10 ), orderIndex
] );
789 cssHeader
: 'headerSort',
790 cssAsc
: 'headerSortUp',
791 cssDesc
: 'headerSortDown',
792 cssChildRow
: 'expand-child',
793 sortMultiSortKey
: 'shiftKey',
794 unsortableClass
: 'unsortable',
796 cancelSelection
: true,
808 * @param {jQuery} $tables
809 * @param {Object} [settings]
812 construct: function ( $tables
, settings
) {
813 return $tables
.each( function ( i
, table
) {
814 // Declare and cache.
815 var $headers
, cache
, config
, sortCSS
, sortMsg
,
820 if ( !table
.tBodies
) {
823 if ( !table
.tHead
) {
824 // No thead found. Look for rows with <th>s and
825 // move them into a <thead> tag or a <tfoot> tag
826 emulateTHeadAndFoot( $table
);
828 // Still no thead? Then quit
829 if ( !table
.tHead
) {
833 // The `sortable` class is used to identify tables which will become sortable
834 // If not used it will create a FOUC but it should be added since the sortable class
835 // is responsible for certain crucial style elements. If the class is already present
836 // this action will be harmless.
837 $table
.addClass( 'jquery-tablesorter sortable' );
840 config
= $.extend( {}, $.tablesorter
.defaultOptions
, settings
);
842 // Save the settings where they read
843 $.data( table
, 'tablesorter', { config
: config
} );
845 // Get the CSS class names, could be done elsewhere
846 sortCSS
= [ config
.cssAsc
, config
.cssDesc
];
847 // Messages tell the user what the *next* state will be
848 // so are in reverse order to the CSS classes.
849 sortMsg
= [ mw
.msg( 'sort-descending' ), mw
.msg( 'sort-ascending' ) ];
852 $headers
= buildHeaders( table
, sortMsg
);
854 // Grab and process locale settings.
855 buildTransformTable();
858 // Precaching regexps can bring 10 fold
859 // performance improvements in some browsers.
862 function setupForFirstSort() {
863 var $tfoot
, $sortbottoms
;
867 // Defer buildCollationTable to first sort. As user and site scripts
868 // may customize tableSorterCollation but load after $.ready(), other
869 // scripts may call .tablesorter() before they have done the
870 // tableSorterCollation customizations.
871 buildCollationTable();
873 // Legacy fix of .sortbottoms
874 // Wrap them inside a tfoot (because that's what they actually want to be)
875 // and put the <tfoot> at the end of the <table>
876 $sortbottoms
= $table
.find( '> tbody > tr.sortbottom' );
877 if ( $sortbottoms
.length
) {
878 $tfoot
= $table
.children( 'tfoot' );
879 if ( $tfoot
.length
) {
880 $tfoot
.eq( 0 ).prepend( $sortbottoms
);
882 $table
.append( $( '<tfoot>' ).append( $sortbottoms
) );
886 explodeRowspans( $table
);
887 manageColspans( $table
);
889 // Try to auto detect column type, and store in tables config
890 config
.parsers
= buildParserCache( table
, $headers
);
893 // Apply event handling to headers
894 // this is too big, perhaps break it out?
895 $headers
.on( 'keypress click', function ( e
) {
896 var cell
, $cell
, columns
, newSortList
, i
,
900 if ( e
.type
=== 'click' && e
.target
.nodeName
.toLowerCase() === 'a' ) {
901 // The user clicked on a link inside a table header.
902 // Do nothing and let the default link click action continue.
906 if ( e
.type
=== 'keypress' && e
.which
!== 13 ) {
907 // Only handle keypresses on the "Enter" key.
915 // Build the cache for the tbody cells
916 // to share between calculations for this sort action.
917 // Re-calculated each time a sort action is performed due to possibility
918 // that sort values change. Shouldn't be too expensive, but if it becomes
919 // too slow an event based system should be implemented somehow where
920 // cells get event .change() and bubbles up to the <table> here
921 cache
= buildCache( table
);
923 totalRows
= ( $table
[ 0 ].tBodies
[ 0 ] && $table
[ 0 ].tBodies
[ 0 ].rows
.length
) || 0;
924 if ( totalRows
> 0 ) {
928 // Get current column sort order
930 order
: $cell
.data( 'count' ) % 2,
931 count
: $cell
.data( 'count' ) + 1
935 // Get current column index
936 columns
= config
.headerToColumns
[ $cell
.data( 'headerIndex' ) ];
937 newSortList
= columns
.map( function ( c
) {
938 return [ c
, $cell
.data( 'order' ) ];
940 // Index of first column belonging to this header
943 if ( !e
[ config
.sortMultiSortKey
] ) {
944 // User only wants to sort on one column set
945 // Flush the sort list and add new columns
946 config
.sortList
= newSortList
;
948 // Multi column sorting
949 // It is not possible for one column to belong to multiple headers,
950 // so this is okay - we don't need to check for every value in the columns array
951 if ( isValueInArray( i
, config
.sortList
) ) {
952 // The user has clicked on an already sorted column.
953 // Reverse the sorting direction for all tables.
954 for ( j
= 0; j
< config
.sortList
.length
; j
++ ) {
955 s
= config
.sortList
[ j
];
956 o
= config
.headerList
[ config
.columnToHeader
[ s
[ 0 ] ] ];
957 if ( isValueInArray( s
[ 0 ], newSortList
) ) {
958 $( o
).data( 'count', s
[ 1 ] + 1 );
959 s
[ 1 ] = $( o
).data( 'count' ) % 2;
963 // Add columns to sort list array
964 config
.sortList
= config
.sortList
.concat( newSortList
);
968 // Reset order/counts of cells not affected by sorting
969 setHeadersOrder( $headers
, config
.sortList
, config
.headerToColumns
);
971 // Set CSS for headers
972 setHeadersCss( $table
[ 0 ], $headers
, config
.sortList
, sortCSS
, sortMsg
, config
.columnToHeader
);
974 $table
[ 0 ], multisort( $table
[ 0 ], config
.sortList
, cache
)
977 // Stop normal event by returning false
982 } ).on( 'mousedown', function () {
983 if ( config
.cancelSelection
) {
984 this.onselectstart = function () {
992 * Sorts the table. If no sorting is specified by passing a list of sort
993 * objects, the table is sorted according to the initial sorting order.
994 * Passing an empty array will reset sorting (basically just reset the headers
995 * making the table appear unsorted).
997 * @param {Array} [sortList] List of sort objects.
999 $table
.data( 'tablesorter' ).sort = function ( sortList
) {
1002 setupForFirstSort();
1005 if ( sortList
=== undefined ) {
1006 sortList
= config
.sortList
;
1007 } else if ( sortList
.length
> 0 ) {
1008 sortList
= convertSortList( sortList
);
1011 // Set each column's sort count to be able to determine the correct sort
1012 // order when clicking on a header cell the next time
1013 setHeadersOrder( $headers
, sortList
, config
.headerToColumns
);
1015 // re-build the cache for the tbody cells
1016 cache
= buildCache( table
);
1018 // set css for headers
1019 setHeadersCss( table
, $headers
, sortList
, sortCSS
, sortMsg
, config
.columnToHeader
);
1021 // sort the table and append it to the dom
1022 appendToTable( table
, multisort( table
, sortList
, cache
) );
1026 if ( config
.sortList
.length
> 0 ) {
1027 config
.sortList
= convertSortList( config
.sortList
);
1028 $table
.data( 'tablesorter' ).sort();
1034 addParser: function ( parser
) {
1035 if ( !getParserById( parser
.id
) ) {
1036 parsers
.push( parser
);
1040 formatDigit: function ( s
) {
1042 if ( ts
.transformTable
!== false ) {
1044 for ( p
= 0; p
< s
.length
; p
++ ) {
1046 if ( c
in ts
.transformTable
) {
1047 out
+= ts
.transformTable
[ c
];
1054 i
= parseFloat( s
.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) );
1055 return isNaN( i
) ? -Infinity
: i
;
1058 formatFloat: function ( s
) {
1059 var i
= parseFloat( s
);
1060 return isNaN( i
) ? -Infinity
: i
;
1063 formatInt: function ( s
) {
1064 var i
= parseInt( s
, 10 );
1065 return isNaN( i
) ? -Infinity
: i
;
1068 clearTableBody: function ( table
) {
1069 $( table
.tBodies
[ 0 ] ).empty();
1072 getParser: function ( id
) {
1073 buildTransformTable();
1076 buildCollationTable();
1078 return getParserById( id
);
1081 getParsers: function () { // for table diagnosis
1089 // Register as jQuery prototype method
1090 $.fn
.tablesorter = function ( settings
) {
1091 return ts
.construct( this, settings
);
1094 // Add default parsers
1100 format: function ( s
) {
1102 s
= s
.toLowerCase().trim();
1103 if ( ts
.collationRegex
) {
1104 tsc
= ts
.collationTable
;
1105 s
= s
.replace( ts
.collationRegex
, function ( match
) {
1106 var r
= tsc
[ match
] ? tsc
[ match
] : tsc
[ match
.toUpperCase() ];
1107 return r
.toLowerCase();
1117 is: function ( s
) {
1118 return ts
.rgx
.IPAddress
[ 0 ].test( s
);
1120 format: function ( s
) {
1124 for ( i
= 0; i
< a
.length
; i
++ ) {
1126 if ( item
.length
=== 1 ) {
1128 } else if ( item
.length
=== 2 ) {
1134 return $.tablesorter
.formatFloat( r
);
1141 is: function ( s
) {
1142 return ts
.rgx
.currency
[ 0 ].test( s
);
1144 format: function ( s
) {
1145 return $.tablesorter
.formatDigit( s
.replace( ts
.rgx
.currency
[ 1 ], '' ) );
1152 is: function ( s
) {
1153 return ts
.rgx
.url
[ 0 ].test( s
);
1155 format: function ( s
) {
1156 return s
.replace( ts
.rgx
.url
[ 1 ], '' ).trim();
1163 is: function ( s
) {
1164 return ts
.rgx
.isoDate
[ 0 ].test( s
);
1166 format: function ( s
) {
1167 var match
, i
, isodate
, ms
, hOffset
, mOffset
;
1168 match
= s
.match( ts
.rgx
.isoDate
[ 0 ] );
1169 if ( match
=== null ) {
1170 // Otherwise a signed number with 1-4 digit is parsed as isoDate
1171 match
= s
.match( ts
.rgx
.isoDate
[ 1 ] );
1177 for ( i
= 2; i
<= 4; i
+= 2 ) {
1178 if ( !match
[ i
] || match
[ i
].length
=== 0 ) {
1183 for ( i
= 6; i
<= 15; i
++ ) {
1184 if ( !match
[ i
] || match
[ i
].length
=== 0 ) {
1188 ms
= parseFloat( match
[ 11 ].replace( /,/, '.' ) ) * 1000;
1189 hOffset
= $.tablesorter
.formatInt( match
[ 13 ] + match
[ 14 ] );
1190 mOffset
= $.tablesorter
.formatInt( match
[ 13 ] + match
[ 15 ] );
1192 isodate
= new Date( 0 );
1193 // Because Date constructor changes year 0-99 to 1900-1999, use setUTCFullYear()
1194 isodate
.setUTCFullYear( match
[ 1 ], match
[ 2 ] - 1, match
[ 4 ] );
1195 isodate
.setUTCHours( match
[ 6 ] - hOffset
, match
[ 8 ] - mOffset
, match
[ 10 ], ms
);
1196 return isodate
.getTime();
1203 is: function ( s
) {
1204 return ts
.rgx
.usLongDate
[ 0 ].test( s
);
1206 format: function ( s
) {
1207 return $.tablesorter
.formatFloat( new Date( s
).getTime() );
1214 is: function ( s
) {
1215 return ( ts
.dateRegex
[ 0 ].test( s
) || ts
.dateRegex
[ 1 ].test( s
) || ts
.dateRegex
[ 2 ].test( s
) );
1217 format: function ( s
) {
1219 s
= s
.toLowerCase().trim();
1221 if ( ( match
= s
.match( ts
.dateRegex
[ 0 ] ) ) !== null ) {
1222 if ( mw
.config
.get( 'wgDefaultDateFormat' ) === 'mdy' || mw
.config
.get( 'wgPageContentLanguage' ) === 'en' ) {
1223 s
= [ match
[ 3 ], match
[ 1 ], match
[ 2 ] ];
1224 } else if ( mw
.config
.get( 'wgDefaultDateFormat' ) === 'dmy' ) {
1225 s
= [ match
[ 3 ], match
[ 2 ], match
[ 1 ] ];
1227 // If we get here, we don't know which order the dd-dd-dddd
1228 // date is in. So return something not entirely invalid.
1231 } else if ( ( match
= s
.match( ts
.dateRegex
[ 1 ] ) ) !== null ) {
1232 s
= [ match
[ 3 ], String( ts
.monthNames
[ match
[ 2 ] ] ), match
[ 1 ] ];
1233 } else if ( ( match
= s
.match( ts
.dateRegex
[ 2 ] ) ) !== null ) {
1234 s
= [ match
[ 3 ], String( ts
.monthNames
[ match
[ 1 ] ] ), match
[ 2 ] ];
1236 // Should never get here
1240 // Pad Month and Day
1241 if ( s
[ 1 ].length
=== 1 ) {
1242 s
[ 1 ] = '0' + s
[ 1 ];
1244 if ( s
[ 2 ].length
=== 1 ) {
1245 s
[ 2 ] = '0' + s
[ 2 ];
1248 if ( ( y
= parseInt( s
[ 0 ], 10 ) ) < 100 ) {
1249 // Guestimate years without centuries
1256 while ( s
[ 0 ].length
< 4 ) {
1257 s
[ 0 ] = '0' + s
[ 0 ];
1259 return parseInt( s
.join( '' ), 10 );
1266 is: function ( s
) {
1267 return ts
.rgx
.time
[ 0 ].test( s
);
1269 format: function ( s
) {
1270 return $.tablesorter
.formatFloat( new Date( '2000/01/01 ' + s
).getTime() );
1277 is: function ( s
) {
1278 return $.tablesorter
.numberRegex
.test( s
.trim() );
1280 format: function ( s
) {
1281 return $.tablesorter
.formatDigit( s
);