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 protected $mLastShown, $mFirstShown, $mPastTheEndIndex, $mDefaultQuery, $mNavigationBar;
103 * Result object for the query. Warning: seek before use.
109 public function __construct( IContextSource
$context = null ) {
111 $this->setContext( $context );
114 $this->mRequest
= $this->getRequest();
116 # NB: the offset is quoted, not validated. It is treated as an
117 # arbitrary string to support the widest variety of index types. Be
118 # careful outputting it into HTML!
119 $this->mOffset
= $this->mRequest
->getText( 'offset' );
121 # Use consistent behavior for the limit options
122 $this->mDefaultLimit
= intval( $this->getUser()->getOption( 'rclimit' ) );
123 list( $this->mLimit
, /* $offset */ ) = $this->mRequest
->getLimitOffset();
125 $this->mIsBackwards
= ( $this->mRequest
->getVal( 'dir' ) == 'prev' );
126 $this->mDb
= wfGetDB( DB_SLAVE
);
128 $index = $this->getIndexField(); // column to sort on
129 $extraSort = $this->getExtraSortFields(); // extra columns to sort on for query planning
130 $order = $this->mRequest
->getVal( 'order' );
131 if( is_array( $index ) && isset( $index[$order] ) ) {
132 $this->mOrderType
= $order;
133 $this->mIndexField
= $index[$order];
134 $this->mExtraSortFields
= isset( $extraSort[$order] )
135 ?
(array)$extraSort[$order]
137 } elseif( is_array( $index ) ) {
138 # First element is the default
140 list( $this->mOrderType
, $this->mIndexField
) = each( $index );
141 $this->mExtraSortFields
= isset( $extraSort[$this->mOrderType
] )
142 ?
(array)$extraSort[$this->mOrderType
]
145 # $index is not an array
146 $this->mOrderType
= null;
147 $this->mIndexField
= $index;
148 $this->mExtraSortFields
= (array)$extraSort;
151 if( !isset( $this->mDefaultDirection
) ) {
152 $dir = $this->getDefaultDirections();
153 $this->mDefaultDirection
= is_array( $dir )
154 ?
$dir[$this->mOrderType
]
160 * Do the query, using information from the object context. This function
161 * has been kept minimal to make it overridable if necessary, to allow for
162 * result sets formed from multiple DB queries.
164 public function doQuery() {
165 # Use the child class name for profiling
166 $fname = __METHOD__
. ' (' . get_class( $this ) . ')';
167 wfProfileIn( $fname );
169 $descending = ( $this->mIsBackwards
== $this->mDefaultDirection
);
170 # Plus an extra row so that we can tell the "next" link should be shown
171 $queryLimit = $this->mLimit +
1;
173 $this->mResult
= $this->reallyDoQuery(
178 $this->extractResultInfo( $this->mOffset
, $queryLimit, $this->mResult
);
179 $this->mQueryDone
= true;
181 $this->preprocessResults( $this->mResult
);
182 $this->mResult
->rewind(); // Paranoia
184 wfProfileOut( $fname );
188 * @return ResultWrapper The result wrapper.
190 function getResult() {
191 return $this->mResult
;
195 * Set the offset from an other source than the request
197 * @param $offset Int|String
199 function setOffset( $offset ) {
200 $this->mOffset
= $offset;
203 * Set the limit from an other source than the request
205 * @param $limit Int|String
207 function setLimit( $limit ) {
208 $this->mLimit
= $limit;
212 * Extract some useful data from the result object for use by
213 * the navigation bar, put it into $this
215 * @param $offset String: index offset, inclusive
216 * @param $limit Integer: exact query limit
217 * @param $res ResultWrapper
219 function extractResultInfo( $offset, $limit, ResultWrapper
$res ) {
220 $numRows = $res->numRows();
222 # Remove any table prefix from index field
223 $parts = explode( '.', $this->mIndexField
);
224 $indexColumn = end( $parts );
226 $row = $res->fetchRow();
227 $firstIndex = $row[$indexColumn];
229 # Discard the extra result row if there is one
230 if ( $numRows > $this->mLimit
&& $numRows > 1 ) {
231 $res->seek( $numRows - 1 );
232 $this->mPastTheEndRow
= $res->fetchObject();
233 $indexField = $this->mIndexField
;
234 $this->mPastTheEndIndex
= $this->mPastTheEndRow
->$indexField;
235 $res->seek( $numRows - 2 );
236 $row = $res->fetchRow();
237 $lastIndex = $row[$indexColumn];
239 $this->mPastTheEndRow
= null;
240 # Setting indexes to an empty string means that they will be
241 # omitted if they would otherwise appear in URLs. It just so
242 # happens that this is the right thing to do in the standard
243 # UI, in all the relevant cases.
244 $this->mPastTheEndIndex
= '';
245 $res->seek( $numRows - 1 );
246 $row = $res->fetchRow();
247 $lastIndex = $row[$indexColumn];
252 $this->mPastTheEndRow
= null;
253 $this->mPastTheEndIndex
= '';
256 if ( $this->mIsBackwards
) {
257 $this->mIsFirst
= ( $numRows < $limit );
258 $this->mIsLast
= ( $offset == '' );
259 $this->mLastShown
= $firstIndex;
260 $this->mFirstShown
= $lastIndex;
262 $this->mIsFirst
= ( $offset == '' );
263 $this->mIsLast
= ( $numRows < $limit );
264 $this->mLastShown
= $lastIndex;
265 $this->mFirstShown
= $firstIndex;
270 * Get some text to go in brackets in the "function name" part of the SQL comment
274 function getSqlComment() {
275 return get_class( $this );
279 * Do a query with specified parameters, rather than using the object
282 * @param $offset String: index offset, inclusive
283 * @param $limit Integer: exact query limit
284 * @param $descending Boolean: query direction, false for ascending, true for descending
285 * @return ResultWrapper
287 function reallyDoQuery( $offset, $limit, $descending ) {
288 $fname = __METHOD__
. ' (' . $this->getSqlComment() . ')';
289 $info = $this->getQueryInfo();
290 $tables = $info['tables'];
291 $fields = $info['fields'];
292 $conds = isset( $info['conds'] ) ?
$info['conds'] : array();
293 $options = isset( $info['options'] ) ?
$info['options'] : array();
294 $join_conds = isset( $info['join_conds'] ) ?
$info['join_conds'] : array();
295 $sortColumns = array_merge( array( $this->mIndexField
), $this->mExtraSortFields
);
297 $options['ORDER BY'] = implode( ',', $sortColumns );
301 foreach ( $sortColumns as $col ) {
302 $orderBy[] = $col . ' DESC';
304 $options['ORDER BY'] = implode( ',', $orderBy );
307 if ( $offset != '' ) {
308 $conds[] = $this->mIndexField
. $operator . $this->mDb
->addQuotes( $offset );
310 $options['LIMIT'] = intval( $limit );
311 $res = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
312 return new ResultWrapper( $this->mDb
, $res );
316 * Pre-process results; useful for performing batch existence checks, etc.
318 * @param $result ResultWrapper
320 protected function preprocessResults( $result ) {}
323 * Get the formatted result list. Calls getStartBody(), formatRow() and
324 * getEndBody(), concatenates the results and returns them.
329 if ( !$this->mQueryDone
) {
332 # Don't use any extra rows returned by the query
333 $numRows = min( $this->mResult
->numRows(), $this->mLimit
);
335 $s = $this->getStartBody();
337 if ( $this->mIsBackwards
) {
338 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
339 $this->mResult
->seek( $i );
340 $row = $this->mResult
->fetchObject();
341 $s .= $this->formatRow( $row );
344 $this->mResult
->seek( 0 );
345 for ( $i = 0; $i < $numRows; $i++
) {
346 $row = $this->mResult
->fetchObject();
347 $s .= $this->formatRow( $row );
351 $s .= $this->getEmptyBody();
353 $s .= $this->getEndBody();
360 * @param $text String: text displayed on the link
361 * @param $query Array: associative array of paramter to be in the query string
362 * @param $type String: value of the "rel" attribute
363 * @return String: HTML fragment
365 function makeLink($text, $query = null, $type=null) {
366 if ( $query === null ) {
371 if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
372 # HTML5 rel attributes
373 $attrs['rel'] = $type;
377 $attrs['class'] = "mw-{$type}link";
379 return Linker
::linkKnown(
383 $query +
$this->getDefaultQuery()
388 * Hook into getBody(), allows text to be inserted at the start. This
389 * will be called even if there are no rows in the result set.
393 function getStartBody() {
398 * Hook into getBody() for the end of the list
402 function getEndBody() {
407 * Hook into getBody(), for the bit between the start and the
408 * end when there are no rows
412 function getEmptyBody() {
417 * Get an array of query parameters that should be put into self-links.
418 * By default, all parameters passed in the URL are used, except for a
421 * @return Associative array
423 function getDefaultQuery() {
424 if ( !isset( $this->mDefaultQuery
) ) {
425 $this->mDefaultQuery
= $this->getRequest()->getQueryValues();
426 unset( $this->mDefaultQuery
['title'] );
427 unset( $this->mDefaultQuery
['dir'] );
428 unset( $this->mDefaultQuery
['offset'] );
429 unset( $this->mDefaultQuery
['limit'] );
430 unset( $this->mDefaultQuery
['order'] );
431 unset( $this->mDefaultQuery
['month'] );
432 unset( $this->mDefaultQuery
['year'] );
434 return $this->mDefaultQuery
;
438 * Get the number of rows in the result set
442 function getNumRows() {
443 if ( !$this->mQueryDone
) {
446 return $this->mResult
->numRows();
450 * Get a URL query array for the prev, next, first and last links.
454 function getPagingQueries() {
455 if ( !$this->mQueryDone
) {
459 # Don't announce the limit everywhere if it's the default
460 $urlLimit = $this->mLimit
== $this->mDefaultLimit ?
'' : $this->mLimit
;
462 if ( $this->mIsFirst
) {
468 'offset' => $this->mFirstShown
,
471 $first = array( 'limit' => $urlLimit );
473 if ( $this->mIsLast
) {
477 $next = array( 'offset' => $this->mLastShown
, 'limit' => $urlLimit );
478 $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
489 * Returns whether to show the "navigation bar"
493 function isNavigationBarShown() {
494 if ( !$this->mQueryDone
) {
497 // Hide navigation by default if there is nothing to page
498 return !($this->mIsFirst
&& $this->mIsLast
);
502 * Get paging links. If a link is disabled, the item from $disabledTexts
503 * will be used. If there is no such item, the unlinked text from
504 * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
507 * @param $linkTexts Array
508 * @param $disabledTexts Array
511 function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
512 $queries = $this->getPagingQueries();
514 foreach ( $queries as $type => $query ) {
515 if ( $query !== false ) {
516 $links[$type] = $this->makeLink(
521 } elseif ( isset( $disabledTexts[$type] ) ) {
522 $links[$type] = $disabledTexts[$type];
524 $links[$type] = $linkTexts[$type];
530 function getLimitLinks() {
532 if ( $this->mIsBackwards
) {
533 $offset = $this->mPastTheEndIndex
;
535 $offset = $this->mOffset
;
537 foreach ( $this->mLimitsShown
as $limit ) {
538 $links[] = $this->makeLink(
539 $this->getLang()->formatNum( $limit ),
540 array( 'offset' => $offset, 'limit' => $limit ),
548 * Abstract formatting function. This should return an HTML string
549 * representing the result row $row. Rows will be concatenated and
550 * returned by getBody()
552 * @param $row Object: database row
555 abstract function formatRow( $row );
558 * This function should be overridden to provide all parameters
559 * needed for the main paged query. It returns an associative
560 * array with the following elements:
561 * tables => Table(s) for passing to Database::select()
562 * fields => Field(s) for passing to Database::select(), may be *
563 * conds => WHERE conditions
564 * options => option array
565 * join_conds => JOIN conditions
569 abstract function getQueryInfo();
572 * This function should be overridden to return the name of the index fi-
573 * eld. If the pager supports multiple orders, it may return an array of
574 * 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
575 * will use indexfield to sort. In this case, the first returned key is
578 * Needless to say, it's really not a good idea to use a non-unique index
579 * for this! That won't page right.
581 * @return string|Array
583 abstract function getIndexField();
586 * This function should be overridden to return the names of secondary columns
587 * to order by in addition to the column in getIndexField(). These fields will
588 * not be used in the pager offset or in any links for users.
590 * If getIndexField() returns an array of 'querykey' => 'indexfield' pairs then
591 * this must return a corresponding array of 'querykey' => array( fields...) pairs
592 * in order for a request with &count=querykey to use array( fields...) to sort.
594 * This is useful for pagers that GROUP BY a unique column (say page_id)
595 * and ORDER BY another (say page_len). Using GROUP BY and ORDER BY both on
596 * page_len,page_id avoids temp tables (given a page_len index). This would
597 * also work if page_id was non-unique but we had a page_len,page_id index.
601 protected function getExtraSortFields() { return array(); }
604 * Return the default sorting direction: false for ascending, true for de-
605 * scending. You can also have an associative array of ordertype => dir,
606 * if multiple order types are supported. In this case getIndexField()
607 * must return an array, and the keys of that must exactly match the keys
610 * For backward compatibility, this method's return value will be ignored
611 * if $this->mDefaultDirection is already set when the constructor is
612 * called, for instance if it's statically initialized. In that case the
613 * value of that variable (which must be a boolean) will be used.
615 * Note that despite its name, this does not return the value of the
616 * $this->mDefaultDirection member variable. That's the default for this
617 * particular instantiation, which is a single value. This is the set of
618 * all defaults for the class.
622 protected function getDefaultDirections() { return false; }
627 * IndexPager with an alphabetic list and a formatted navigation bar
630 abstract class AlphabeticPager
extends IndexPager
{
633 * Shamelessly stolen bits from ReverseChronologicalPager,
634 * didn't want to do class magic as may be still revamped
636 * @return String HTML
638 function getNavigationBar() {
639 if ( !$this->isNavigationBarShown() ) return '';
641 if( isset( $this->mNavigationBar
) ) {
642 return $this->mNavigationBar
;
645 $lang = $this->getLang();
647 $opts = array( 'parsemag', 'escapenoentities' );
652 $lang->formatNum( $this->mLimit
)
657 $lang->formatNum($this->mLimit
)
659 'first' => wfMsgExt( 'page_first', $opts ),
660 'last' => wfMsgExt( 'page_last', $opts )
663 $pagingLinks = $this->getPagingLinks( $linkTexts );
664 $limitLinks = $this->getLimitLinks();
665 $limits = $lang->pipeList( $limitLinks );
667 $this->mNavigationBar
=
668 "(" . $lang->pipeList(
669 array( $pagingLinks['first'],
670 $pagingLinks['last'] )
672 wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
673 $pagingLinks['next'], $limits );
675 if( !is_array( $this->getIndexField() ) ) {
676 # Early return to avoid undue nesting
677 return $this->mNavigationBar
;
682 $msgs = $this->getOrderTypeMessages();
683 foreach( array_keys( $msgs ) as $order ) {
687 $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
690 if( $order == $this->mOrderType
) {
691 $extra .= wfMsgHTML( $msgs[$order] );
693 $extra .= $this->makeLink(
694 wfMsgHTML( $msgs[$order] ),
695 array( 'order' => $order )
700 if( $extra !== '' ) {
701 $this->mNavigationBar
.= " ($extra)";
704 return $this->mNavigationBar
;
708 * If this supports multiple order type messages, give the message key for
709 * enabling each one in getNavigationBar. The return type is an associa-
710 * tive array whose keys must exactly match the keys of the array returned
711 * by getIndexField(), and whose values are message keys.
715 protected function getOrderTypeMessages() {
721 * IndexPager with a formatted navigation bar
724 abstract class ReverseChronologicalPager
extends IndexPager
{
725 public $mDefaultDirection = true;
729 function getNavigationBar() {
730 if ( !$this->isNavigationBarShown() ) {
734 if ( isset( $this->mNavigationBar
) ) {
735 return $this->mNavigationBar
;
738 $nicenumber = $this->getLang()->formatNum( $this->mLimit
);
742 array( 'parsemag', 'escape' ),
747 array( 'parsemag', 'escape' ),
750 'first' => wfMsgHtml( 'histlast' ),
751 'last' => wfMsgHtml( 'histfirst' )
754 $pagingLinks = $this->getPagingLinks( $linkTexts );
755 $limitLinks = $this->getLimitLinks();
756 $limits = $this->getLang()->pipeList( $limitLinks );
758 $this->mNavigationBar
= "({$pagingLinks['first']}" .
759 wfMsgExt( 'pipe-separator' , 'escapenoentities' ) .
760 "{$pagingLinks['last']}) " .
763 $pagingLinks['prev'], $pagingLinks['next'],
766 return $this->mNavigationBar
;
769 function getDateCond( $year, $month ) {
770 $year = intval($year);
771 $month = intval($month);
772 // Basic validity checks
773 $this->mYear
= $year > 0 ?
$year : false;
774 $this->mMonth
= ($month > 0 && $month < 13) ?
$month : false;
775 // Given an optional year and month, we need to generate a timestamp
776 // to use as "WHERE rev_timestamp <= result"
777 // Examples: year = 2006 equals < 20070101 (+000000)
778 // year=2005, month=1 equals < 20050201
779 // year=2005, month=12 equals < 20060101
780 if ( !$this->mYear
&& !$this->mMonth
) {
783 if ( $this->mYear
) {
784 $year = $this->mYear
;
786 // If no year given, assume the current one
787 $year = gmdate( 'Y' );
788 // If this month hasn't happened yet this year, go back to last year's month
789 if( $this->mMonth
> gmdate( 'n' ) ) {
793 if ( $this->mMonth
) {
794 $month = $this->mMonth +
1;
795 // For December, we want January 1 of the next year
801 // No month implies we want up to the end of the year in question
806 if ( $year > 2032 ) {
809 $ymd = (int)sprintf( "%04d%02d01", $year, $month );
810 if ( $ymd > 20320101 ) {
813 $this->mOffset
= $this->mDb
->timestamp( "${ymd}000000" );
818 * Table-based display with a user-selectable sort order
821 abstract class TablePager
extends IndexPager
{
825 function __construct( IContextSource
$context = null ) {
827 $this->setContext( $context );
830 $this->mSort
= $this->getRequest()->getText( 'sort' );
831 if ( !array_key_exists( $this->mSort
, $this->getFieldNames() ) ) {
832 $this->mSort
= $this->getDefaultSort();
834 if ( $this->getRequest()->getBool( 'asc' ) ) {
835 $this->mDefaultDirection
= false;
836 } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
837 $this->mDefaultDirection
= true;
838 } /* Else leave it at whatever the class default is */
840 parent
::__construct();
843 function getStartBody() {
845 $tableClass = htmlspecialchars( $this->getTableClass() );
846 $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
848 $s = "<table style='border:1;' class=\"mw-datatable $tableClass\"><thead><tr>\n";
849 $fields = $this->getFieldNames();
852 foreach ( $fields as $field => $name ) {
853 if ( strval( $name ) == '' ) {
854 $s .= "<th> </th>\n";
855 } elseif ( $this->isFieldSortable( $field ) ) {
856 $query = array( 'sort' => $field, 'limit' => $this->mLimit
);
857 if ( $field == $this->mSort
) {
858 # This is the sorted column
859 # Prepare a link that goes in the other sort order
860 if ( $this->mDefaultDirection
) {
862 $image = 'Arr_d.png';
865 $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
868 $image = 'Arr_u.png';
870 $query['desc'] = '1';
871 $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
873 $image = htmlspecialchars( "$wgStylePath/common/images/$image" );
874 $link = $this->makeLink(
875 "<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
876 htmlspecialchars( $name ), $query );
877 $s .= "<th class=\"$sortClass\">$link</th>\n";
879 $s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
882 $s .= '<th>' . htmlspecialchars( $name ) . "</th>\n";
885 $s .= "</tr></thead><tbody>\n";
889 function getEndBody() {
890 return "</tbody></table>\n";
893 function getEmptyBody() {
894 $colspan = count( $this->getFieldNames() );
895 $msgEmpty = wfMsgHtml( 'table_pager_empty' );
896 return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
901 * @return String HTML
903 function formatRow( $row ) {
904 $this->mCurrentRow
= $row; # In case formatValue etc need to know
905 $s = Xml
::openElement( 'tr', $this->getRowAttrs( $row ) );
906 $fieldNames = $this->getFieldNames();
907 foreach ( $fieldNames as $field => $name ) {
908 $value = isset( $row->$field ) ?
$row->$field : null;
909 $formatted = strval( $this->formatValue( $field, $value ) );
910 if ( $formatted == '' ) {
911 $formatted = ' ';
913 $s .= Xml
::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
920 * Get a class name to be applied to the given row.
922 * @param $row Object: the database result row
925 function getRowClass( $row ) {
930 * Get attributes to be applied to the given row.
932 * @param $row Object: the database result row
933 * @return Array of <attr> => <value>
935 function getRowAttrs( $row ) {
936 $class = $this->getRowClass( $row );
937 if ( $class === '' ) {
938 // Return an empty array to avoid clutter in HTML like class=""
941 return array( 'class' => $this->getRowClass( $row ) );
946 * Get any extra attributes to be applied to the given cell. Don't
947 * take this as an excuse to hardcode styles; use classes and
948 * CSS instead. Row context is available in $this->mCurrentRow
950 * @param $field String The column
951 * @param $value String The cell contents
952 * @return Array of attr => value
954 function getCellAttrs( $field, $value ) {
955 return array( 'class' => 'TablePager_col_' . $field );
958 function getIndexField() {
962 function getTableClass() {
966 function getNavClass() {
967 return 'TablePager_nav';
970 function getSortHeaderClass() {
971 return 'TablePager_sort';
975 * A navigation bar with images
976 * @return String HTML
978 function getNavigationBar() {
981 if ( !$this->isNavigationBarShown() ) {
985 $path = "$wgStylePath/common/images";
987 'first' => 'table_pager_first',
988 'prev' => 'table_pager_prev',
989 'next' => 'table_pager_next',
990 'last' => 'table_pager_last',
993 'first' => 'arrow_first_25.png',
994 'prev' => 'arrow_left_25.png',
995 'next' => 'arrow_right_25.png',
996 'last' => 'arrow_last_25.png',
998 $disabledImages = array(
999 'first' => 'arrow_disabled_first_25.png',
1000 'prev' => 'arrow_disabled_left_25.png',
1001 'next' => 'arrow_disabled_right_25.png',
1002 'last' => 'arrow_disabled_last_25.png',
1004 if( $this->getLang()->isRTL() ) {
1005 $keys = array_keys( $labels );
1006 $images = array_combine( $keys, array_reverse( $images ) );
1007 $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
1010 $linkTexts = array();
1011 $disabledTexts = array();
1012 foreach ( $labels as $type => $label ) {
1013 $msgLabel = wfMsgHtml( $label );
1014 $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
1015 $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
1017 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
1019 $navClass = htmlspecialchars( $this->getNavClass() );
1020 $s = "<table class=\"$navClass\"><tr>\n";
1021 $width = 100 / count( $links ) . '%';
1022 foreach ( $labels as $type => $label ) {
1023 $s .= "<td style='width:$width;'>{$links[$type]}</td>\n";
1025 $s .= "</tr></table>\n";
1030 * Get a <select> element which has options for each of the allowed limits
1032 * @return String: HTML fragment
1034 function getLimitSelect() {
1035 # Add the current limit from the query string
1036 # to avoid that the limit is lost after clicking Go next time
1037 if ( !in_array( $this->mLimit
, $this->mLimitsShown
) ) {
1038 $this->mLimitsShown
[] = $this->mLimit
;
1039 sort( $this->mLimitsShown
);
1041 $s = Html
::openElement( 'select', array( 'name' => 'limit' ) ) . "\n";
1042 foreach ( $this->mLimitsShown
as $key => $value ) {
1043 # The pair is either $index => $limit, in which case the $value
1044 # will be numeric, or $limit => $text, in which case the $value
1046 if( is_int( $value ) ){
1048 $text = $this->getLang()->formatNum( $limit );
1053 $s .= Xml
::option( $text, $limit, $limit == $this->mLimit
) . "\n";
1055 $s .= Html
::closeElement( 'select' );
1060 * Get <input type="hidden"> elements for use in a method="get" form.
1061 * Resubmits all defined elements of the query string, except for a
1062 * blacklist, passed in the $blacklist parameter.
1064 * @param $blacklist Array parameters from the request query which should not be resubmitted
1065 * @return String: HTML fragment
1067 function getHiddenFields( $blacklist = array() ) {
1068 $blacklist = (array)$blacklist;
1069 $query = $this->getRequest()->getQueryValues();
1070 foreach ( $blacklist as $name ) {
1071 unset( $query[$name] );
1074 foreach ( $query as $name => $value ) {
1075 $encName = htmlspecialchars( $name );
1076 $encValue = htmlspecialchars( $value );
1077 $s .= "<input type=\"hidden\" name=\"$encName\" value=\"$encValue\"/>\n";
1083 * Get a form containing a limit selection dropdown
1085 * @return String: HTML fragment
1087 function getLimitForm() {
1090 return Xml
::openElement(
1094 'action' => $wgScript
1095 ) ) . "\n" . $this->getLimitDropdown() . "</form>\n";
1099 * Gets a limit selection dropdown
1103 function getLimitDropdown() {
1104 # Make the select with some explanatory text
1105 $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
1107 return wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
1108 "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
1109 $this->getHiddenFields( array( 'limit' ) );
1113 * Return true if the named field should be sortable by the UI, false
1116 * @param $field String
1118 abstract function isFieldSortable( $field );
1121 * Format a table cell. The return value should be HTML, but use an empty
1122 * string not   for empty cells. Do not include the <td> and </td>.
1124 * The current result row is available as $this->mCurrentRow, in case you
1125 * need more context.
1127 * @param $name String: the database field name
1128 * @param $value String: the value retrieved from the database
1130 abstract function formatValue( $name, $value );
1133 * The database field name used as a default sort order
1135 abstract function getDefaultSort();
1138 * An array mapping database field names to a textual description of the
1139 * field name, for use in the table header. The description should be plain
1140 * text, it will be HTML-escaped later.
1144 abstract function getFieldNames();