Fix for r47482: put the RELEASE-NOTES entry in the "bug fixes" section and not the...
[mediawiki.git] / includes / Pager.php
blob8faec533224f2978458f6efdbedc035d7e4757db
1 <?php
2 /**
3 * @defgroup Pager Pager
5 * @file
6 * @ingroup Pager
7 */
9 /**
10 * Basic pager interface.
11 * @ingroup Pager
13 interface Pager {
14 function getNavigationBar();
15 function getBody();
18 /**
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 PageHistory.php and
54 * SpecialIpblocklist.php. You just need to override formatRow(),
55 * getQueryInfo() and getIndexField(). Don't forget to call the parent
56 * constructor if you override it.
58 * @ingroup Pager
60 abstract class IndexPager implements Pager {
61 public $mRequest;
62 public $mLimitsShown = array( 20, 50, 100, 250, 500 );
63 public $mDefaultLimit = 50;
64 public $mOffset, $mLimit;
65 public $mQueryDone = false;
66 public $mDb;
67 public $mPastTheEndRow;
69 /**
70 * The index to actually be used for ordering. This is a single string e-
71 * ven if multiple orderings are supported.
73 protected $mIndexField;
74 /** For pages that support multiple types of ordering, which one to use. */
75 protected $mOrderType;
76 /**
77 * $mDefaultDirection gives the direction to use when sorting results:
78 * false for ascending, true for descending. If $mIsBackwards is set, we
79 * start from the opposite end, but we still sort the page itself according
80 * to $mDefaultDirection. E.g., if $mDefaultDirection is false but we're
81 * going backwards, we'll display the last page of results, but the last
82 * result will be at the bottom, not the top.
84 * Like $mIndexField, $mDefaultDirection will be a single value even if the
85 * class supports multiple default directions for different order types.
87 public $mDefaultDirection;
88 public $mIsBackwards;
90 /**
91 * Result object for the query. Warning: seek before use.
93 public $mResult;
95 public function __construct() {
96 global $wgRequest, $wgUser;
97 $this->mRequest = $wgRequest;
99 # NB: the offset is quoted, not validated. It is treated as an
100 # arbitrary string to support the widest variety of index types. Be
101 # careful outputting it into HTML!
102 $this->mOffset = $this->mRequest->getText( 'offset' );
104 # Use consistent behavior for the limit options
105 $this->mDefaultLimit = intval( $wgUser->getOption( 'rclimit' ) );
106 list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset();
108 $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' );
109 $this->mDb = wfGetDB( DB_SLAVE );
111 $index = $this->getIndexField();
112 $order = $this->mRequest->getVal( 'order' );
113 if( is_array( $index ) && isset( $index[$order] ) ) {
114 $this->mOrderType = $order;
115 $this->mIndexField = $index[$order];
116 } elseif( is_array( $index ) ) {
117 # First element is the default
118 reset( $index );
119 list( $this->mOrderType, $this->mIndexField ) = each( $index );
120 } else {
121 # $index is not an array
122 $this->mOrderType = null;
123 $this->mIndexField = $index;
126 if( !isset( $this->mDefaultDirection ) ) {
127 $dir = $this->getDefaultDirections();
128 $this->mDefaultDirection = is_array( $dir )
129 ? $dir[$this->mOrderType]
130 : $dir;
135 * Do the query, using information from the object context. This function
136 * has been kept minimal to make it overridable if necessary, to allow for
137 * result sets formed from multiple DB queries.
139 function doQuery() {
140 # Use the child class name for profiling
141 $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
142 wfProfileIn( $fname );
144 $descending = ( $this->mIsBackwards == $this->mDefaultDirection );
145 # Plus an extra row so that we can tell the "next" link should be shown
146 $queryLimit = $this->mLimit + 1;
148 $this->mResult = $this->reallyDoQuery( $this->mOffset, $queryLimit, $descending );
149 $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
150 $this->mQueryDone = true;
152 $this->preprocessResults( $this->mResult );
153 $this->mResult->rewind(); // Paranoia
155 wfProfileOut( $fname );
159 * Return the result wrapper.
161 function getResult() {
162 return $this->mResult;
166 * Set the offset from an other source than $wgRequest
168 function setOffset( $offset ) {
169 $this->mOffset = $offset;
172 * Set the limit from an other source than $wgRequest
174 function setLimit( $limit ) {
175 $this->mLimit = $limit;
179 * Extract some useful data from the result object for use by
180 * the navigation bar, put it into $this
182 function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
183 $numRows = $res->numRows();
184 if ( $numRows ) {
185 $row = $res->fetchRow();
186 $firstIndex = $row[$this->mIndexField];
188 # Discard the extra result row if there is one
189 if ( $numRows > $this->mLimit && $numRows > 1 ) {
190 $res->seek( $numRows - 1 );
191 $this->mPastTheEndRow = $res->fetchObject();
192 $indexField = $this->mIndexField;
193 $this->mPastTheEndIndex = $this->mPastTheEndRow->$indexField;
194 $res->seek( $numRows - 2 );
195 $row = $res->fetchRow();
196 $lastIndex = $row[$this->mIndexField];
197 } else {
198 $this->mPastTheEndRow = null;
199 # Setting indexes to an empty string means that they will be
200 # omitted if they would otherwise appear in URLs. It just so
201 # happens that this is the right thing to do in the standard
202 # UI, in all the relevant cases.
203 $this->mPastTheEndIndex = '';
204 $res->seek( $numRows - 1 );
205 $row = $res->fetchRow();
206 $lastIndex = $row[$this->mIndexField];
208 } else {
209 $firstIndex = '';
210 $lastIndex = '';
211 $this->mPastTheEndRow = null;
212 $this->mPastTheEndIndex = '';
215 if ( $this->mIsBackwards ) {
216 $this->mIsFirst = ( $numRows < $limit );
217 $this->mIsLast = ( $offset == '' );
218 $this->mLastShown = $firstIndex;
219 $this->mFirstShown = $lastIndex;
220 } else {
221 $this->mIsFirst = ( $offset == '' );
222 $this->mIsLast = ( $numRows < $limit );
223 $this->mLastShown = $lastIndex;
224 $this->mFirstShown = $firstIndex;
229 * Do a query with specified parameters, rather than using the object
230 * context
232 * @param string $offset Index offset, inclusive
233 * @param integer $limit Exact query limit
234 * @param boolean $descending Query direction, false for ascending, true for descending
235 * @return ResultWrapper
237 function reallyDoQuery( $offset, $limit, $descending ) {
238 $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
239 $info = $this->getQueryInfo();
240 $tables = $info['tables'];
241 $fields = $info['fields'];
242 $conds = isset( $info['conds'] ) ? $info['conds'] : array();
243 $options = isset( $info['options'] ) ? $info['options'] : array();
244 $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
245 if ( $descending ) {
246 $options['ORDER BY'] = $this->mIndexField;
247 $operator = '>';
248 } else {
249 $options['ORDER BY'] = $this->mIndexField . ' DESC';
250 $operator = '<';
252 if ( $offset != '' ) {
253 $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
255 $options['LIMIT'] = intval( $limit );
256 $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
257 return new ResultWrapper( $this->mDb, $res );
261 * Pre-process results; useful for performing batch existence checks, etc.
263 * @param ResultWrapper $result Result wrapper
265 protected function preprocessResults( $result ) {}
268 * Get the formatted result list. Calls getStartBody(), formatRow() and
269 * getEndBody(), concatenates the results and returns them.
271 function getBody() {
272 if ( !$this->mQueryDone ) {
273 $this->doQuery();
275 # Don't use any extra rows returned by the query
276 $numRows = min( $this->mResult->numRows(), $this->mLimit );
278 $s = $this->getStartBody();
279 if ( $numRows ) {
280 if ( $this->mIsBackwards ) {
281 for ( $i = $numRows - 1; $i >= 0; $i-- ) {
282 $this->mResult->seek( $i );
283 $row = $this->mResult->fetchObject();
284 $s .= $this->formatRow( $row );
286 } else {
287 $this->mResult->seek( 0 );
288 for ( $i = 0; $i < $numRows; $i++ ) {
289 $row = $this->mResult->fetchObject();
290 $s .= $this->formatRow( $row );
293 } else {
294 $s .= $this->getEmptyBody();
296 $s .= $this->getEndBody();
297 return $s;
301 * Make a self-link
303 function makeLink($text, $query = null, $type=null) {
304 if ( $query === null ) {
305 return $text;
308 $attrs = array();
309 if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
310 # HTML5 rel attributes
311 $attrs['rel'] = $type;
314 if( $type ) {
315 $attrs['class'] = "mw-{$type}link";
317 return $this->getSkin()->link( $this->getTitle(), $text,
318 $attrs, $query + $this->getDefaultQuery(), array('noclasses','known') );
322 * Hook into getBody(), allows text to be inserted at the start. This
323 * will be called even if there are no rows in the result set.
325 function getStartBody() {
326 return '';
330 * Hook into getBody() for the end of the list
332 function getEndBody() {
333 return '';
337 * Hook into getBody(), for the bit between the start and the
338 * end when there are no rows
340 function getEmptyBody() {
341 return '';
345 * Title used for self-links. Override this if you want to be able to
346 * use a title other than $wgTitle
348 function getTitle() {
349 return $GLOBALS['wgTitle'];
353 * Get the current skin. This can be overridden if necessary.
355 function getSkin() {
356 if ( !isset( $this->mSkin ) ) {
357 global $wgUser;
358 $this->mSkin = $wgUser->getSkin();
360 return $this->mSkin;
364 * Get an array of query parameters that should be put into self-links.
365 * By default, all parameters passed in the URL are used, except for a
366 * short blacklist.
368 function getDefaultQuery() {
369 if ( !isset( $this->mDefaultQuery ) ) {
370 $this->mDefaultQuery = $_GET;
371 unset( $this->mDefaultQuery['title'] );
372 unset( $this->mDefaultQuery['dir'] );
373 unset( $this->mDefaultQuery['offset'] );
374 unset( $this->mDefaultQuery['limit'] );
375 unset( $this->mDefaultQuery['order'] );
376 unset( $this->mDefaultQuery['month'] );
377 unset( $this->mDefaultQuery['year'] );
379 return $this->mDefaultQuery;
383 * Get the number of rows in the result set
385 function getNumRows() {
386 if ( !$this->mQueryDone ) {
387 $this->doQuery();
389 return $this->mResult->numRows();
393 * Get a URL query array for the prev, next, first and last links.
395 function getPagingQueries() {
396 if ( !$this->mQueryDone ) {
397 $this->doQuery();
400 # Don't announce the limit everywhere if it's the default
401 $urlLimit = $this->mLimit == $this->mDefaultLimit ? '' : $this->mLimit;
403 if ( $this->mIsFirst ) {
404 $prev = false;
405 $first = false;
406 } else {
407 $prev = array( 'dir' => 'prev', 'offset' => $this->mFirstShown, 'limit' => $urlLimit );
408 $first = array( 'limit' => $urlLimit );
410 if ( $this->mIsLast ) {
411 $next = false;
412 $last = false;
413 } else {
414 $next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
415 $last = array( 'dir' => 'prev', 'limit' => $urlLimit );
417 return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last );
421 * Get paging links. If a link is disabled, the item from $disabledTexts
422 * will be used. If there is no such item, the unlinked text from
423 * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
424 * of HTML.
426 function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
427 $queries = $this->getPagingQueries();
428 $links = array();
429 foreach ( $queries as $type => $query ) {
430 if ( $query !== false ) {
431 $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type );
432 } elseif ( isset( $disabledTexts[$type] ) ) {
433 $links[$type] = $disabledTexts[$type];
434 } else {
435 $links[$type] = $linkTexts[$type];
438 return $links;
441 function getLimitLinks() {
442 global $wgLang;
443 $links = array();
444 if ( $this->mIsBackwards ) {
445 $offset = $this->mPastTheEndIndex;
446 } else {
447 $offset = $this->mOffset;
449 foreach ( $this->mLimitsShown as $limit ) {
450 $links[] = $this->makeLink( $wgLang->formatNum( $limit ),
451 array( 'offset' => $offset, 'limit' => $limit ), 'num' );
453 return $links;
457 * Abstract formatting function. This should return an HTML string
458 * representing the result row $row. Rows will be concatenated and
459 * returned by getBody()
461 abstract function formatRow( $row );
464 * This function should be overridden to provide all parameters
465 * needed for the main paged query. It returns an associative
466 * array with the following elements:
467 * tables => Table(s) for passing to Database::select()
468 * fields => Field(s) for passing to Database::select(), may be *
469 * conds => WHERE conditions
470 * options => option array
472 abstract function getQueryInfo();
475 * This function should be overridden to return the name of the index fi-
476 * eld. If the pager supports multiple orders, it may return an array of
477 * 'querykey' => 'indexfield' pairs, so that a request with &count=querykey
478 * will use indexfield to sort. In this case, the first returned key is
479 * the default.
481 * Needless to say, it's really not a good idea to use a non-unique index
482 * for this! That won't page right.
484 abstract function getIndexField();
487 * Return the default sorting direction: false for ascending, true for de-
488 * scending. You can also have an associative array of ordertype => dir,
489 * if multiple order types are supported. In this case getIndexField()
490 * must return an array, and the keys of that must exactly match the keys
491 * of this.
493 * For backward compatibility, this method's return value will be ignored
494 * if $this->mDefaultDirection is already set when the constructor is
495 * called, for instance if it's statically initialized. In that case the
496 * value of that variable (which must be a boolean) will be used.
498 * Note that despite its name, this does not return the value of the
499 * $this->mDefaultDirection member variable. That's the default for this
500 * particular instantiation, which is a single value. This is the set of
501 * all defaults for the class.
503 protected function getDefaultDirections() { return false; }
508 * IndexPager with an alphabetic list and a formatted navigation bar
509 * @ingroup Pager
511 abstract class AlphabeticPager extends IndexPager {
513 * Shamelessly stolen bits from ReverseChronologicalPager,
514 * didn't want to do class magic as may be still revamped
516 function getNavigationBar() {
517 global $wgLang;
519 if( isset( $this->mNavigationBar ) ) {
520 return $this->mNavigationBar;
523 $opts = array( 'parsemag', 'escapenoentities' );
524 $linkTexts = array(
525 'prev' => wfMsgExt( 'prevn', $opts, $wgLang->formatNum( $this->mLimit ) ),
526 'next' => wfMsgExt( 'nextn', $opts, $wgLang->formatNum($this->mLimit ) ),
527 'first' => wfMsgExt( 'page_first', $opts ),
528 'last' => wfMsgExt( 'page_last', $opts )
531 $pagingLinks = $this->getPagingLinks( $linkTexts );
532 $limitLinks = $this->getLimitLinks();
533 $limits = $wgLang->pipeList( $limitLinks );
535 $this->mNavigationBar =
536 "(" . $wgLang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " .
537 wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
538 $pagingLinks['next'], $limits );
540 if( !is_array( $this->getIndexField() ) ) {
541 # Early return to avoid undue nesting
542 return $this->mNavigationBar;
545 $extra = '';
546 $first = true;
547 $msgs = $this->getOrderTypeMessages();
548 foreach( array_keys( $msgs ) as $order ) {
549 if( $first ) {
550 $first = false;
551 } else {
552 $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
555 if( $order == $this->mOrderType ) {
556 $extra .= wfMsgHTML( $msgs[$order] );
557 } else {
558 $extra .= $this->makeLink(
559 wfMsgHTML( $msgs[$order] ),
560 array( 'order' => $order )
565 if( $extra !== '' ) {
566 $this->mNavigationBar .= " ($extra)";
569 return $this->mNavigationBar;
573 * If this supports multiple order type messages, give the message key for
574 * enabling each one in getNavigationBar. The return type is an associa-
575 * tive array whose keys must exactly match the keys of the array returned
576 * by getIndexField(), and whose values are message keys.
577 * @return array
579 protected function getOrderTypeMessages() {
580 return null;
585 * IndexPager with a formatted navigation bar
586 * @ingroup Pager
588 abstract class ReverseChronologicalPager extends IndexPager {
589 public $mDefaultDirection = true;
590 public $mYear;
591 public $mMonth;
593 function __construct() {
594 parent::__construct();
597 function getNavigationBar() {
598 global $wgLang;
600 if ( isset( $this->mNavigationBar ) ) {
601 return $this->mNavigationBar;
603 $nicenumber = $wgLang->formatNum( $this->mLimit );
604 $linkTexts = array(
605 'prev' => wfMsgExt( 'pager-newer-n', array( 'parsemag' ), $nicenumber ),
606 'next' => wfMsgExt( 'pager-older-n', array( 'parsemag' ), $nicenumber ),
607 'first' => wfMsgHtml( 'histlast' ),
608 'last' => wfMsgHtml( 'histfirst' )
611 $pagingLinks = $this->getPagingLinks( $linkTexts );
612 $limitLinks = $this->getLimitLinks();
613 $limits = $wgLang->pipeList( $limitLinks );
615 $this->mNavigationBar = "({$pagingLinks['first']}" . wfMsgExt( 'pipe-separator' , 'escapenoentities' ) . "{$pagingLinks['last']}) " .
616 wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits);
617 return $this->mNavigationBar;
620 function getDateCond( $year, $month ) {
621 $year = intval($year);
622 $month = intval($month);
623 // Basic validity checks
624 $this->mYear = $year > 0 ? $year : false;
625 $this->mMonth = ($month > 0 && $month < 13) ? $month : false;
626 // Given an optional year and month, we need to generate a timestamp
627 // to use as "WHERE rev_timestamp <= result"
628 // Examples: year = 2006 equals < 20070101 (+000000)
629 // year=2005, month=1 equals < 20050201
630 // year=2005, month=12 equals < 20060101
631 if ( !$this->mYear && !$this->mMonth ) {
632 return;
634 if ( $this->mYear ) {
635 $year = $this->mYear;
636 } else {
637 // If no year given, assume the current one
638 $year = gmdate( 'Y' );
639 // If this month hasn't happened yet this year, go back to last year's month
640 if( $this->mMonth > gmdate( 'n' ) ) {
641 $year--;
644 if ( $this->mMonth ) {
645 $month = $this->mMonth + 1;
646 // For December, we want January 1 of the next year
647 if ($month > 12) {
648 $month = 1;
649 $year++;
651 } else {
652 // No month implies we want up to the end of the year in question
653 $month = 1;
654 $year++;
656 // Y2K38 bug
657 if ( $year > 2032 ) {
658 $year = 2032;
660 $ymd = (int)sprintf( "%04d%02d01", $year, $month );
661 if ( $ymd > 20320101 ) {
662 $ymd = 20320101;
664 $this->mOffset = $this->mDb->timestamp( "${ymd}000000" );
669 * Table-based display with a user-selectable sort order
670 * @ingroup Pager
672 abstract class TablePager extends IndexPager {
673 var $mSort;
674 var $mCurrentRow;
676 function __construct() {
677 global $wgRequest;
678 $this->mSort = $wgRequest->getText( 'sort' );
679 if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) {
680 $this->mSort = $this->getDefaultSort();
682 if ( $wgRequest->getBool( 'asc' ) ) {
683 $this->mDefaultDirection = false;
684 } elseif ( $wgRequest->getBool( 'desc' ) ) {
685 $this->mDefaultDirection = true;
686 } /* Else leave it at whatever the class default is */
688 parent::__construct();
691 function getStartBody() {
692 global $wgStylePath;
693 $tableClass = htmlspecialchars( $this->getTableClass() );
694 $sortClass = htmlspecialchars( $this->getSortHeaderClass() );
696 $s = "<table border='1' class=\"$tableClass\"><thead><tr>\n";
697 $fields = $this->getFieldNames();
699 # Make table header
700 foreach ( $fields as $field => $name ) {
701 if ( strval( $name ) == '' ) {
702 $s .= "<th>&nbsp;</th>\n";
703 } elseif ( $this->isFieldSortable( $field ) ) {
704 $query = array( 'sort' => $field, 'limit' => $this->mLimit );
705 if ( $field == $this->mSort ) {
706 # This is the sorted column
707 # Prepare a link that goes in the other sort order
708 if ( $this->mDefaultDirection ) {
709 # Descending
710 $image = 'Arr_u.png';
711 $query['asc'] = '1';
712 $query['desc'] = '';
713 $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
714 } else {
715 # Ascending
716 $image = 'Arr_d.png';
717 $query['asc'] = '';
718 $query['desc'] = '1';
719 $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
721 $image = htmlspecialchars( "$wgStylePath/common/images/$image" );
722 $link = $this->makeLink(
723 "<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
724 htmlspecialchars( $name ), $query );
725 $s .= "<th class=\"$sortClass\">$link</th>\n";
726 } else {
727 $s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
729 } else {
730 $s .= '<th>' . htmlspecialchars( $name ) . "</th>\n";
733 $s .= "</tr></thead><tbody>\n";
734 return $s;
737 function getEndBody() {
738 return "</tbody></table>\n";
741 function getEmptyBody() {
742 $colspan = count( $this->getFieldNames() );
743 $msgEmpty = wfMsgHtml( 'table_pager_empty' );
744 return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
747 function formatRow( $row ) {
748 $rowClass = $this->getRowClass( $row );
749 $s = "<tr class=\"$rowClass\">\n";
750 $fieldNames = $this->getFieldNames();
751 $this->mCurrentRow = $row; # In case formatValue needs to know
752 foreach ( $fieldNames as $field => $name ) {
753 $value = isset( $row->$field ) ? $row->$field : null;
754 $formatted = strval( $this->formatValue( $field, $value ) );
755 if ( $formatted == '' ) {
756 $formatted = '&nbsp;';
758 $class = 'TablePager_col_' . htmlspecialchars( $field );
759 $s .= "<td class=\"$class\">$formatted</td>\n";
761 $s .= "</tr>\n";
762 return $s;
765 function getRowClass($row) {
766 return '';
769 function getIndexField() {
770 return $this->mSort;
773 function getTableClass() {
774 return 'TablePager';
777 function getNavClass() {
778 return 'TablePager_nav';
781 function getSortHeaderClass() {
782 return 'TablePager_sort';
786 * A navigation bar with images
788 function getNavigationBar() {
789 global $wgStylePath, $wgContLang;
790 $path = "$wgStylePath/common/images";
791 $labels = array(
792 'first' => 'table_pager_first',
793 'prev' => 'table_pager_prev',
794 'next' => 'table_pager_next',
795 'last' => 'table_pager_last',
797 $images = array(
798 'first' => $wgContLang->isRTL() ? 'arrow_last_25.png' : 'arrow_first_25.png',
799 'prev' => $wgContLang->isRTL() ? 'arrow_right_25.png' : 'arrow_left_25.png',
800 'next' => $wgContLang->isRTL() ? 'arrow_left_25.png' : 'arrow_right_25.png',
801 'last' => $wgContLang->isRTL() ? 'arrow_first_25.png' : 'arrow_last_25.png',
803 $disabledImages = array(
804 'first' => $wgContLang->isRTL() ? 'arrow_disabled_last_25.png' : 'arrow_disabled_first_25.png',
805 'prev' => $wgContLang->isRTL() ? 'arrow_disabled_right_25.png' : 'arrow_disabled_left_25.png',
806 'next' => $wgContLang->isRTL() ? 'arrow_disabled_left_25.png' : 'arrow_disabled_right_25.png',
807 'last' => $wgContLang->isRTL() ? 'arrow_disabled_first_25.png' : 'arrow_disabled_last_25.png',
810 $linkTexts = array();
811 $disabledTexts = array();
812 foreach ( $labels as $type => $label ) {
813 $msgLabel = wfMsgHtml( $label );
814 $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
815 $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
817 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
819 $navClass = htmlspecialchars( $this->getNavClass() );
820 $s = "<table class=\"$navClass\" align=\"center\" cellpadding=\"3\"><tr>\n";
821 $cellAttrs = 'valign="top" align="center" width="' . 100 / count( $links ) . '%"';
822 foreach ( $labels as $type => $label ) {
823 $s .= "<td $cellAttrs>{$links[$type]}</td>\n";
825 $s .= "</tr></table>\n";
826 return $s;
830 * Get a <select> element which has options for each of the allowed limits
832 function getLimitSelect() {
833 global $wgLang;
834 $s = "<select name=\"limit\">";
835 foreach ( $this->mLimitsShown as $limit ) {
836 $selected = $limit == $this->mLimit ? 'selected="selected"' : '';
837 $formattedLimit = $wgLang->formatNum( $limit );
838 $s .= "<option value=\"$limit\" $selected>$formattedLimit</option>\n";
840 $s .= "</select>";
841 return $s;
845 * Get <input type="hidden"> elements for use in a method="get" form.
846 * Resubmits all defined elements of the $_GET array, except for a
847 * blacklist, passed in the $blacklist parameter.
849 function getHiddenFields( $blacklist = array() ) {
850 $blacklist = (array)$blacklist;
851 $query = $_GET;
852 foreach ( $blacklist as $name ) {
853 unset( $query[$name] );
855 $s = '';
856 foreach ( $query as $name => $value ) {
857 $encName = htmlspecialchars( $name );
858 $encValue = htmlspecialchars( $value );
859 $s .= "<input type=\"hidden\" name=\"$encName\" value=\"$encValue\"/>\n";
861 return $s;
865 * Get a form containing a limit selection dropdown
867 function getLimitForm() {
868 # Make the select with some explanatory text
869 $url = $this->getTitle()->escapeLocalURL();
870 $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
871 return
872 "<form method=\"get\" action=\"$url\">" .
873 wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
874 "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
875 $this->getHiddenFields( array('limit','title') ) .
876 "</form>\n";
880 * Return true if the named field should be sortable by the UI, false
881 * otherwise
883 * @param string $field
885 abstract function isFieldSortable( $field );
888 * Format a table cell. The return value should be HTML, but use an empty
889 * string not &nbsp; for empty cells. Do not include the <td> and </td>.
891 * The current result row is available as $this->mCurrentRow, in case you
892 * need more context.
894 * @param string $name The database field name
895 * @param string $value The value retrieved from the database
897 abstract function formatValue( $name, $value );
900 * The database field name used as a default sort order
902 abstract function getDefaultSort();
905 * An array mapping database field names to a textual description of the
906 * field name, for use in the table header. The description should be plain
907 * text, it will be HTML-escaped later.
909 abstract function getFieldNames();