3 * @defgroup Pager Pager
10 * Basic pager interface.
14 function getNavigationBar();
19 * IndexPager is an efficient pager which uses a (roughly unique) index in the
20 * data set to implement paging, rather than a "LIMIT offset,limit" clause.
21 * In MySQL, such a limit/offset clause requires counting through the
22 * specified number of offset rows to find the desired data, which can be
23 * expensive for large offsets.
25 * ReverseChronologicalPager is a child class of the abstract IndexPager, and
26 * contains some formatting and display code which is specific to the use of
27 * timestamps as indexes. Here is a synopsis of its operation:
29 * * The query is specified by the offset, limit and direction (dir)
30 * parameters, in addition to any subclass-specific parameters.
31 * * The offset is the non-inclusive start of the DB query. A row with an
32 * index value equal to the offset will never be shown.
33 * * The query may either be done backwards, where the rows are returned by
34 * the database in the opposite order to which they are displayed to the
35 * user, or forwards. This is specified by the "dir" parameter, dir=prev
36 * means backwards, anything else means forwards. The offset value
37 * specifies the start of the database result set, which may be either
38 * the start or end of the displayed data set. This allows "previous"
39 * links to be implemented without knowledge of the index value at the
40 * start of the previous page.
41 * * An additional row beyond the user-specified limit is always requested.
42 * This allows us to tell whether we should display a "next" link in the
43 * case of forwards mode, or a "previous" link in the case of backwards
44 * mode. Determining whether to display the other link (the one for the
45 * page before the start of the database result set) can be done
46 * heuristically by examining the offset.
48 * * An empty offset indicates that the offset condition should be omitted
49 * from the query. This naturally produces either the first page or the
50 * last page depending on the dir parameter.
52 * Subclassing the pager to implement concrete functionality should be fairly
53 * simple, please see the examples in HistoryPage.php and
54 * SpecialBlockList.php. You just need to override formatRow(),
55 * getQueryInfo() and getIndexField(). Don't forget to call the parent
56 * constructor if you override it.
60 abstract class IndexPager
extends ContextSource
implements Pager
{
62 public $mLimitsShown = array( 20, 50, 100, 250, 500 );
63 public $mDefaultLimit = 50;
64 public $mOffset, $mLimit;
65 public $mQueryDone = false;
67 public $mPastTheEndRow;
70 * The index to actually be used for ordering. This is a single column,
71 * for one ordering, even if multiple orderings are supported.
73 protected $mIndexField;
75 * An array of secondary columns to order by. These fields are not part of the offset.
76 * This is a column list for one ordering, even if multiple orderings are supported.
78 protected $mExtraSortFields;
79 /** For pages that support multiple types of ordering, which one to use.
81 protected $mOrderType;
83 * $mDefaultDirection gives the direction to use when sorting results:
84 * false for ascending, true for descending. If $mIsBackwards is set, we
85 * start from the opposite end, but we still sort the page itself according
86 * to $mDefaultDirection. E.g., if $mDefaultDirection is false but we're
87 * going backwards, we'll display the last page of results, but the last
88 * result will be at the bottom, not the top.
90 * Like $mIndexField, $mDefaultDirection will be a single value even if the
91 * class supports multiple default directions for different order types.
93 public $mDefaultDirection;
96 /** True if the current result set is the first one */
100 * Result object for the query. Warning: seek before use.
106 public function __construct( IContextSource
$context = null ) {
108 $this->setContext( $context );
111 $this->mRequest
= $this->getRequest();
113 # NB: the offset is quoted, not validated. It is treated as an
114 # arbitrary string to support the widest variety of index types. Be
115 # careful outputting it into HTML!
116 $this->mOffset
= $this->mRequest
->getText( 'offset' );
118 # Use consistent behavior for the limit options
119 $this->mDefaultLimit
= intval( $this->getUser()->getOption( 'rclimit' ) );
120 list( $this->mLimit
, /* $offset */ ) = $this->mRequest
->getLimitOffset();
122 $this->mIsBackwards
= ( $this->mRequest
->getVal( 'dir' ) == 'prev' );
123 $this->mDb
= wfGetDB( DB_SLAVE
);
125 $index = $this->getIndexField(); // column to sort on
126 $extraSort = $this->getExtraSortFields(); // extra columns to sort on for query planning
127 $order = $this->mRequest
->getVal( 'order' );
128 if( is_array( $index ) && isset( $index[$order] ) ) {
129 $this->mOrderType
= $order;
130 $this->mIndexField
= $index[$order];
131 $this->mExtraSortFields
= isset( $extraSort[$order] )
132 ?
(array)$extraSort[$order]
134 } elseif( is_array( $index ) ) {
135 # First element is the default
137 list( $this->mOrderType
, $this->mIndexField
) = each( $index );
138 $this->mExtraSortFields
= isset( $extraSort[$this->mOrderType
] )
139 ?
(array)$extraSort[$this->mOrderType
]
142 # $index is not an array
143 $this->mOrderType
= null;
144 $this->mIndexField
= $index;
145 $this->mExtraSortFields
= (array)$extraSort;
148 if( !isset( $this->mDefaultDirection
) ) {
149 $dir = $this->getDefaultDirections();
150 $this->mDefaultDirection
= is_array( $dir )
151 ?
$dir[$this->mOrderType
]
157 * Do the query, using information from the object context. This function
158 * has been kept minimal to make it overridable if necessary, to allow for
159 * result sets formed from multiple DB queries.
161 public function doQuery() {
162 # Use the child class name for profiling
163 $fname = __METHOD__
. ' (' . get_class( $this ) . ')';
164 wfProfileIn( $fname );
166 $descending = ( $this->mIsBackwards
== $this->mDefaultDirection
);
167 # Plus an extra row so that we can tell the "next" link should be shown
168 $queryLimit = $this->mLimit +
1;
170 $this->mResult
= $this->reallyDoQuery(
175 $this->extractResultInfo( $this->mOffset
, $queryLimit, $this->mResult
);
176 $this->mQueryDone
= true;
178 $this->preprocessResults( $this->mResult
);
179 $this->mResult
->rewind(); // Paranoia
181 wfProfileOut( $fname );
185 * @return ResultWrapper The result wrapper.
187 function getResult() {
188 return $this->mResult
;
192 * Set the offset from an other source than the request
194 function setOffset( $offset ) {
195 $this->mOffset
= $offset;
198 * Set the limit from an other source than the request
200 function setLimit( $limit ) {
201 $this->mLimit
= $limit;
205 * Extract some useful data from the result object for use by
206 * the navigation bar, put it into $this
208 * @param $offset String: index offset, inclusive
209 * @param $limit Integer: exact query limit
210 * @param $res ResultWrapper
212 function extractResultInfo( $offset, $limit, ResultWrapper
$res ) {
213 $numRows = $res->numRows();
215 # Remove any table prefix from index field
216 $parts = explode( '.', $this->mIndexField
);
217 $indexColumn = end( $parts );
219 $row = $res->fetchRow();
220 $firstIndex = $row[$indexColumn];
222 # Discard the extra result row if there is one
223 if ( $numRows > $this->mLimit
&& $numRows > 1 ) {
224 $res->seek( $numRows - 1 );
225 $this->mPastTheEndRow
= $res->fetchObject();
226 $indexField = $this->mIndexField
;
227 $this->mPastTheEndIndex
= $this->mPastTheEndRow
->$indexField;
228 $res->seek( $numRows - 2 );
229 $row = $res->fetchRow();
230 $lastIndex = $row[$indexColumn];
232 $this->mPastTheEndRow
= null;
233 # Setting indexes to an empty string means that they will be
234 # omitted if they would otherwise appear in URLs. It just so
235 # happens that this is the right thing to do in the standard
236 # UI, in all the relevant cases.
237 $this->mPastTheEndIndex
= '';
238 $res->seek( $numRows - 1 );
239 $row = $res->fetchRow();
240 $lastIndex = $row[$indexColumn];
245 $this->mPastTheEndRow
= null;
246 $this->mPastTheEndIndex
= '';
249 if ( $this->mIsBackwards
) {
250 $this->mIsFirst
= ( $numRows < $limit );
251 $this->mIsLast
= ( $offset == '' );
252 $this->mLastShown
= $firstIndex;
253 $this->mFirstShown
= $lastIndex;
255 $this->mIsFirst
= ( $offset == '' );
256 $this->mIsLast
= ( $numRows < $limit );
257 $this->mLastShown
= $lastIndex;
258 $this->mFirstShown
= $firstIndex;
263 * Get some text to go in brackets in the "function name" part of the SQL comment
267 function getSqlComment() {
268 return get_class( $this );
272 * Do a query with specified parameters, rather than using the object
275 * @param $offset String: index offset, inclusive
276 * @param $limit Integer: exact query limit
277 * @param $descending Boolean: query direction, false for ascending, true for descending
278 * @return ResultWrapper
280 function reallyDoQuery( $offset, $limit, $descending ) {
281 $fname = __METHOD__
. ' (' . $this->getSqlComment() . ')';
282 $info = $this->getQueryInfo();
283 $tables = $info['tables'];
284 $fields = $info['fields'];
285 $conds = isset( $info['conds'] ) ?
$info['conds'] : array();
286 $options = isset( $info['options'] ) ?
$info['options'] : array();
287 $join_conds = isset( $info['join_conds'] ) ?
$info['join_conds'] : array();
288 $sortColumns = array_merge( array( $this->mIndexField
), $this->mExtraSortFields
);
290 $options['ORDER BY'] = implode( ',', $sortColumns );
294 foreach ( $sortColumns as $col ) {
295 $orderBy[] = $col . ' DESC';
297 $options['ORDER BY'] = implode( ',', $orderBy );
300 if ( $offset != '' ) {
301 $conds[] = $this->mIndexField
. $operator . $this->mDb
->addQuotes( $offset );
303 $options['LIMIT'] = intval( $limit );
304 $res = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
305 return new ResultWrapper( $this->mDb
, $res );
309 * Pre-process results; useful for performing batch existence checks, etc.
311 * @param $result ResultWrapper
313 protected function preprocessResults( $result ) {}
316 * Get the formatted result list. Calls getStartBody(), formatRow() and
317 * getEndBody(), concatenates the results and returns them.
322 if ( !$this->mQueryDone
) {
325 # Don't use any extra rows returned by the query
326 $numRows = min( $this->mResult
->numRows(), $this->mLimit
);
328 $s = $this->getStartBody();
330 if ( $this->mIsBackwards
) {
331 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
332 $this->mResult
->seek( $i );
333 $row = $this->mResult
->fetchObject();
334 $s .= $this->formatRow( $row );
337 $this->mResult
->seek( 0 );
338 for ( $i = 0; $i < $numRows; $i++
) {
339 $row = $this->mResult
->fetchObject();
340 $s .= $this->formatRow( $row );
344 $s .= $this->getEmptyBody();
346 $s .= $this->getEndBody();
353 * @param $text String: text displayed on the link
354 * @param $query Array: associative array of paramter to be in the query string
355 * @param $type String: value of the "rel" attribute
356 * @return String: HTML fragment
358 function makeLink($text, $query = null, $type=null) {
359 if ( $query === null ) {
364 if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
365 # HTML5 rel attributes
366 $attrs['rel'] = $type;
370 $attrs['class'] = "mw-{$type}link";
372 return Linker
::linkKnown(
376 $query +
$this->getDefaultQuery()
381 * Hook into getBody(), allows text to be inserted at the start. This
382 * will be called even if there are no rows in the result set.
386 function getStartBody() {
391 * Hook into getBody() for the end of the list
395 function getEndBody() {
400 * Hook into getBody(), for the bit between the start and the
401 * end when there are no rows
405 function getEmptyBody() {
410 * Get an array of query parameters that should be put into self-links.
411 * By default, all parameters passed in the URL are used, except for a
414 * @return Associative array
416 function getDefaultQuery() {
417 if ( !isset( $this->mDefaultQuery
) ) {
418 $this->mDefaultQuery
= $this->getRequest()->getQueryValues();
419 unset( $this->mDefaultQuery
['title'] );
420 unset( $this->mDefaultQuery
['dir'] );
421 unset( $this->mDefaultQuery
['offset'] );
422 unset( $this->mDefaultQuery
['limit'] );
423 unset( $this->mDefaultQuery
['order'] );
424 unset( $this->mDefaultQuery
['month'] );
425 unset( $this->mDefaultQuery
['year'] );
427 return $this->mDefaultQuery
;
431 * Get the number of rows in the result set
435 function getNumRows() {
436 if ( !$this->mQueryDone
) {
439 return $this->mResult
->numRows();
443 * Get a URL query array for the prev, next, first and last links.
447 function getPagingQueries() {
448 if ( !$this->mQueryDone
) {
452 # Don't announce the limit everywhere if it's the default
453 $urlLimit = $this->mLimit
== $this->mDefaultLimit ?
'' : $this->mLimit
;
455 if ( $this->mIsFirst
) {
461 'offset' => $this->mFirstShown
,
464 $first = array( 'limit' => $urlLimit );
466 if ( $this->mIsLast
) {
470 $next = array( 'offset' => $this->mLastShown
, 'limit' => $urlLimit );
471 $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
482 * Returns whether to show the "navigation bar"
486 function isNavigationBarShown() {
487 if ( !$this->mQueryDone
) {
490 // Hide navigation by default if there is nothing to page
491 return !($this->mIsFirst
&& $this->mIsLast
);
495 * Get paging links. If a link is disabled, the item from $disabledTexts
496 * will be used. If there is no such item, the unlinked text from
497 * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
502 function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
503 $queries = $this->getPagingQueries();
505 foreach ( $queries as $type => $query ) {
506 if ( $query !== false ) {
507 $links[$type] = $this->makeLink(
512 } elseif ( isset( $disabledTexts[$type] ) ) {
513 $links[$type] = $disabledTexts[$type];
515 $links[$type] = $linkTexts[$type];
521 function getLimitLinks() {
523 if ( $this->mIsBackwards
) {
524 $offset = $this->mPastTheEndIndex
;
526 $offset = $this->mOffset
;
528 foreach ( $this->mLimitsShown
as $limit ) {
529 $links[] = $this->makeLink(
530 $this->getLang()->formatNum( $limit ),
531 array( 'offset' => $offset, 'limit' => $limit ),
539 * Abstract formatting function. This should return an HTML string
540 * representing the result row $row. Rows will be concatenated and
541 * returned by getBody()
543 * @param $row Object: database row
546 abstract function formatRow( $row );
549 * This function should be overridden to provide all parameters
550 * needed for the main paged query. It returns an associative
551 * array with the following elements:
552 * tables => Table(s) for passing to Database::select()
553 * fields => Field(s) for passing to Database::select(), may be *
554 * conds => WHERE conditions
555 * options => option array
556 * join_conds => JOIN conditions
560 abstract function getQueryInfo();
563 * This function should be overridden to return the name of the index fi-
564 * eld. If the pager supports multiple orders, it may return an array of
565 * 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
566 * will use indexfield to sort. In this case, the first returned key is
569 * Needless to say, it's really not a good idea to use a non-unique index
570 * for this! That won't page right.
572 * @return string|Array
574 abstract function getIndexField();
577 * This function should be overridden to return the names of secondary columns
578 * to order by in addition to the column in getIndexField(). These fields will
579 * not be used in the pager offset or in any links for users.
581 * If getIndexField() returns an array of 'querykey' => 'indexfield' pairs then
582 * this must return a corresponding array of 'querykey' => array( fields...) pairs
583 * in order for a request with &count=querykey to use array( fields...) to sort.
585 * This is useful for pagers that GROUP BY a unique column (say page_id)
586 * and ORDER BY another (say page_len). Using GROUP BY and ORDER BY both on
587 * page_len,page_id avoids temp tables (given a page_len index). This would
588 * also work if page_id was non-unique but we had a page_len,page_id index.
592 protected function getExtraSortFields() { return array(); }
595 * Return the default sorting direction: false for ascending, true for de-
596 * scending. You can also have an associative array of ordertype => dir,
597 * if multiple order types are supported. In this case getIndexField()
598 * must return an array, and the keys of that must exactly match the keys
601 * For backward compatibility, this method's return value will be ignored
602 * if $this->mDefaultDirection is already set when the constructor is
603 * called, for instance if it's statically initialized. In that case the
604 * value of that variable (which must be a boolean) will be used.
606 * Note that despite its name, this does not return the value of the
607 * $this->mDefaultDirection member variable. That's the default for this
608 * particular instantiation, which is a single value. This is the set of
609 * all defaults for the class.
613 protected function getDefaultDirections() { return false; }
618 * IndexPager with an alphabetic list and a formatted navigation bar
621 abstract class AlphabeticPager
extends IndexPager
{
623 * Shamelessly stolen bits from ReverseChronologicalPager,
624 * didn't want to do class magic as may be still revamped
626 function getNavigationBar() {
627 if ( !$this->isNavigationBarShown() ) return '';
629 if( isset( $this->mNavigationBar
) ) {
630 return $this->mNavigationBar
;
633 $lang = $this->getLang();
635 $opts = array( 'parsemag', 'escapenoentities' );
640 $lang->formatNum( $this->mLimit
)
645 $lang->formatNum($this->mLimit
)
647 'first' => wfMsgExt( 'page_first', $opts ),
648 'last' => wfMsgExt( 'page_last', $opts )
651 $pagingLinks = $this->getPagingLinks( $linkTexts );
652 $limitLinks = $this->getLimitLinks();
653 $limits = $lang->pipeList( $limitLinks );
655 $this->mNavigationBar
=
656 "(" . $lang->pipeList(
657 array( $pagingLinks['first'],
658 $pagingLinks['last'] )
660 wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
661 $pagingLinks['next'], $limits );
663 if( !is_array( $this->getIndexField() ) ) {
664 # Early return to avoid undue nesting
665 return $this->mNavigationBar
;
670 $msgs = $this->getOrderTypeMessages();
671 foreach( array_keys( $msgs ) as $order ) {
675 $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
678 if( $order == $this->mOrderType
) {
679 $extra .= wfMsgHTML( $msgs[$order] );
681 $extra .= $this->makeLink(
682 wfMsgHTML( $msgs[$order] ),
683 array( 'order' => $order )
688 if( $extra !== '' ) {
689 $this->mNavigationBar
.= " ($extra)";
692 return $this->mNavigationBar
;
696 * If this supports multiple order type messages, give the message key for
697 * enabling each one in getNavigationBar. The return type is an associa-
698 * tive array whose keys must exactly match the keys of the array returned
699 * by getIndexField(), and whose values are message keys.
703 protected function getOrderTypeMessages() {
709 * IndexPager with a formatted navigation bar
712 abstract class ReverseChronologicalPager
extends IndexPager
{
713 public $mDefaultDirection = true;
717 function getNavigationBar() {
718 if ( !$this->isNavigationBarShown() ) {
722 if ( isset( $this->mNavigationBar
) ) {
723 return $this->mNavigationBar
;
726 $nicenumber = $this->getLang()->formatNum( $this->mLimit
);
730 array( 'parsemag', 'escape' ),
735 array( 'parsemag', 'escape' ),
738 'first' => wfMsgHtml( 'histlast' ),
739 'last' => wfMsgHtml( 'histfirst' )
742 $pagingLinks = $this->getPagingLinks( $linkTexts );
743 $limitLinks = $this->getLimitLinks();
744 $limits = $this->getLang()->pipeList( $limitLinks );
746 $this->mNavigationBar
= "({$pagingLinks['first']}" .
747 wfMsgExt( 'pipe-separator' , 'escapenoentities' ) .
748 "{$pagingLinks['last']}) " .
751 $pagingLinks['prev'], $pagingLinks['next'],
754 return $this->mNavigationBar
;
757 function getDateCond( $year, $month ) {
758 $year = intval($year);
759 $month = intval($month);
760 // Basic validity checks
761 $this->mYear
= $year > 0 ?
$year : false;
762 $this->mMonth
= ($month > 0 && $month < 13) ?
$month : false;
763 // Given an optional year and month, we need to generate a timestamp
764 // to use as "WHERE rev_timestamp <= result"
765 // Examples: year = 2006 equals < 20070101 (+000000)
766 // year=2005, month=1 equals < 20050201
767 // year=2005, month=12 equals < 20060101
768 if ( !$this->mYear
&& !$this->mMonth
) {
771 if ( $this->mYear
) {
772 $year = $this->mYear
;
774 // If no year given, assume the current one
775 $year = gmdate( 'Y' );
776 // If this month hasn't happened yet this year, go back to last year's month
777 if( $this->mMonth
> gmdate( 'n' ) ) {
781 if ( $this->mMonth
) {
782 $month = $this->mMonth +
1;
783 // For December, we want January 1 of the next year
789 // No month implies we want up to the end of the year in question
794 if ( $year > 2032 ) {
797 $ymd = (int)sprintf( "%04d%02d01", $year, $month );
798 if ( $ymd > 20320101 ) {
801 $this->mOffset
= $this->mDb
->timestamp( "${ymd}000000" );
806 * Table-based display with a user-selectable sort order
809 abstract class TablePager
extends IndexPager
{
813 function __construct( RequestContext
$context = null ) {
815 $this->setContext( $context );
818 $this->mSort
= $this->getRequest()->getText( 'sort' );
819 if ( !array_key_exists( $this->mSort
, $this->getFieldNames() ) ) {
820 $this->mSort
= $this->getDefaultSort();
822 if ( $this->getRequest()->getBool( 'asc' ) ) {
823 $this->mDefaultDirection
= false;
824 } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
825 $this->mDefaultDirection
= true;
826 } /* Else leave it at whatever the class default is */
828 parent
::__construct();
831 function getStartBody() {
833 $tableClass = htmlspecialchars( $this->getTableClass() );
834 $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
836 $s = "<table style='border:1;' class=\"mw-datatable $tableClass\"><thead><tr>\n";
837 $fields = $this->getFieldNames();
840 foreach ( $fields as $field => $name ) {
841 if ( strval( $name ) == '' ) {
842 $s .= "<th> </th>\n";
843 } elseif ( $this->isFieldSortable( $field ) ) {
844 $query = array( 'sort' => $field, 'limit' => $this->mLimit
);
845 if ( $field == $this->mSort
) {
846 # This is the sorted column
847 # Prepare a link that goes in the other sort order
848 if ( $this->mDefaultDirection
) {
850 $image = 'Arr_d.png';
853 $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
856 $image = 'Arr_u.png';
858 $query['desc'] = '1';
859 $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
861 $image = htmlspecialchars( "$wgStylePath/common/images/$image" );
862 $link = $this->makeLink(
863 "<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
864 htmlspecialchars( $name ), $query );
865 $s .= "<th class=\"$sortClass\">$link</th>\n";
867 $s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
870 $s .= '<th>' . htmlspecialchars( $name ) . "</th>\n";
873 $s .= "</tr></thead><tbody>\n";
877 function getEndBody() {
878 return "</tbody></table>\n";
881 function getEmptyBody() {
882 $colspan = count( $this->getFieldNames() );
883 $msgEmpty = wfMsgHtml( 'table_pager_empty' );
884 return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
887 function formatRow( $row ) {
888 $this->mCurrentRow
= $row; # In case formatValue etc need to know
889 $s = Xml
::openElement( 'tr', $this->getRowAttrs($row) );
890 $fieldNames = $this->getFieldNames();
891 foreach ( $fieldNames as $field => $name ) {
892 $value = isset( $row->$field ) ?
$row->$field : null;
893 $formatted = strval( $this->formatValue( $field, $value ) );
894 if ( $formatted == '' ) {
895 $formatted = ' ';
897 $s .= Xml
::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
904 * Get a class name to be applied to the given row.
906 * @param $row Object: the database result row
909 function getRowClass( $row ) {
914 * Get attributes to be applied to the given row.
916 * @param $row Object: the database result row
917 * @return Associative array
919 function getRowAttrs( $row ) {
920 $class = $this->getRowClass( $row );
921 if ( $class === '' ) {
922 // Return an empty array to avoid clutter in HTML like class=""
925 return array( 'class' => $this->getRowClass( $row ) );
930 * Get any extra attributes to be applied to the given cell. Don't
931 * take this as an excuse to hardcode styles; use classes and
932 * CSS instead. Row context is available in $this->mCurrentRow
934 * @param $field The column
935 * @param $value The cell contents
936 * @return Associative array
938 function getCellAttrs( $field, $value ) {
939 return array( 'class' => 'TablePager_col_' . $field );
942 function getIndexField() {
946 function getTableClass() {
950 function getNavClass() {
951 return 'TablePager_nav';
954 function getSortHeaderClass() {
955 return 'TablePager_sort';
959 * A navigation bar with images
961 function getNavigationBar() {
964 if ( !$this->isNavigationBarShown() ) {
968 $path = "$wgStylePath/common/images";
970 'first' => 'table_pager_first',
971 'prev' => 'table_pager_prev',
972 'next' => 'table_pager_next',
973 'last' => 'table_pager_last',
976 'first' => 'arrow_first_25.png',
977 'prev' => 'arrow_left_25.png',
978 'next' => 'arrow_right_25.png',
979 'last' => 'arrow_last_25.png',
981 $disabledImages = array(
982 'first' => 'arrow_disabled_first_25.png',
983 'prev' => 'arrow_disabled_left_25.png',
984 'next' => 'arrow_disabled_right_25.png',
985 'last' => 'arrow_disabled_last_25.png',
987 if( $this->getLang()->isRTL() ) {
988 $keys = array_keys( $labels );
989 $images = array_combine( $keys, array_reverse( $images ) );
990 $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
993 $linkTexts = array();
994 $disabledTexts = array();
995 foreach ( $labels as $type => $label ) {
996 $msgLabel = wfMsgHtml( $label );
997 $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
998 $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
1000 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
1002 $navClass = htmlspecialchars( $this->getNavClass() );
1003 $s = "<table class=\"$navClass\"><tr>\n";
1004 $width = 100 / count( $links ) . '%';
1005 foreach ( $labels as $type => $label ) {
1006 $s .= "<td style='width:$width;'>{$links[$type]}</td>\n";
1008 $s .= "</tr></table>\n";
1013 * Get a <select> element which has options for each of the allowed limits
1015 * @return String: HTML fragment
1017 function getLimitSelect() {
1018 # Add the current limit from the query string
1019 # to avoid that the limit is lost after clicking Go next time
1020 if ( !in_array( $this->mLimit
, $this->mLimitsShown
) ) {
1021 $this->mLimitsShown
[] = $this->mLimit
;
1022 sort( $this->mLimitsShown
);
1024 $s = Html
::openElement( 'select', array( 'name' => 'limit' ) ) . "\n";
1025 foreach ( $this->mLimitsShown
as $key => $value ) {
1026 # The pair is either $index => $limit, in which case the $value
1027 # will be numeric, or $limit => $text, in which case the $value
1029 if( is_int( $value ) ){
1031 $text = $this->getLang()->formatNum( $limit );
1036 $s .= Xml
::option( $text, $limit, $limit == $this->mLimit
) . "\n";
1038 $s .= Html
::closeElement( 'select' );
1043 * Get <input type="hidden"> elements for use in a method="get" form.
1044 * Resubmits all defined elements of the query string, except for a
1045 * blacklist, passed in the $blacklist parameter.
1047 * @return String: HTML fragment
1049 function getHiddenFields( $blacklist = array() ) {
1050 $blacklist = (array)$blacklist;
1051 $query = $this->getRequest()->getQueryValues();
1052 foreach ( $blacklist as $name ) {
1053 unset( $query[$name] );
1056 foreach ( $query as $name => $value ) {
1057 $encName = htmlspecialchars( $name );
1058 $encValue = htmlspecialchars( $value );
1059 $s .= "<input type=\"hidden\" name=\"$encName\" value=\"$encValue\"/>\n";
1065 * Get a form containing a limit selection dropdown
1067 * @return String: HTML fragment
1069 function getLimitForm() {
1072 return Xml
::openElement(
1076 'action' => $wgScript
1077 ) ) . "\n" . $this->getLimitDropdown() . "</form>\n";
1081 * Gets a limit selection dropdown
1085 function getLimitDropdown() {
1086 # Make the select with some explanatory text
1087 $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
1089 return wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
1090 "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
1091 $this->getHiddenFields( array( 'limit' ) );
1095 * Return true if the named field should be sortable by the UI, false
1098 * @param $field String
1100 abstract function isFieldSortable( $field );
1103 * Format a table cell. The return value should be HTML, but use an empty
1104 * string not   for empty cells. Do not include the <td> and </td>.
1106 * The current result row is available as $this->mCurrentRow, in case you
1107 * need more context.
1109 * @param $name String: the database field name
1110 * @param $value String: the value retrieved from the database
1112 abstract function formatValue( $name, $value );
1115 * The database field name used as a default sort order
1117 abstract function getDefaultSort();
1120 * An array mapping database field names to a textual description of the
1121 * field name, for use in the table header. The description should be plain
1122 * text, it will be HTML-escaped later.
1124 abstract function getFieldNames();