diff options
Diffstat (limited to 'includes/Pager.php')
| -rw-r--r-- | includes/Pager.php | 211 |
1 files changed, 127 insertions, 84 deletions
diff --git a/includes/Pager.php b/includes/Pager.php index 81d95593..faae3d2d 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -57,7 +57,7 @@ interface Pager { * * @ingroup Pager */ -abstract class IndexPager implements Pager { +abstract class IndexPager extends ContextSource implements Pager { public $mRequest; public $mLimitsShown = array( 20, 50, 100, 250, 500 ); public $mDefaultLimit = 50; @@ -67,10 +67,15 @@ abstract class IndexPager implements Pager { public $mPastTheEndRow; /** - * The index to actually be used for ordering. This is a single string - * even if multiple orderings are supported. + * The index to actually be used for ordering. This is a single column, + * for one ordering, even if multiple orderings are supported. */ protected $mIndexField; + /** + * An array of secondary columns to order by. These fields are not part of the offset. + * This is a column list for one ordering, even if multiple orderings are supported. + */ + protected $mExtraSortFields; /** For pages that support multiple types of ordering, which one to use. */ protected $mOrderType; @@ -90,6 +95,9 @@ abstract class IndexPager implements Pager { /** True if the current result set is the first one */ public $mIsFirst; + public $mIsLast; + + protected $mLastShown, $mFirstShown, $mPastTheEndIndex, $mDefaultQuery, $mNavigationBar; /** * Result object for the query. Warning: seek before use. @@ -98,9 +106,12 @@ abstract class IndexPager implements Pager { */ public $mResult; - public function __construct() { - global $wgRequest, $wgUser; - $this->mRequest = $wgRequest; + public function __construct( IContextSource $context = null ) { + if ( $context ) { + $this->setContext( $context ); + } + + $this->mRequest = $this->getRequest(); # NB: the offset is quoted, not validated. It is treated as an # arbitrary string to support the widest variety of index types. Be @@ -108,25 +119,33 @@ abstract class IndexPager implements Pager { $this->mOffset = $this->mRequest->getText( 'offset' ); # Use consistent behavior for the limit options - $this->mDefaultLimit = intval( $wgUser->getOption( 'rclimit' ) ); + $this->mDefaultLimit = intval( $this->getUser()->getOption( 'rclimit' ) ); list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset(); $this->mIsBackwards = ( $this->mRequest->getVal( 'dir' ) == 'prev' ); $this->mDb = wfGetDB( DB_SLAVE ); - $index = $this->getIndexField(); + $index = $this->getIndexField(); // column to sort on + $extraSort = $this->getExtraSortFields(); // extra columns to sort on for query planning $order = $this->mRequest->getVal( 'order' ); if( is_array( $index ) && isset( $index[$order] ) ) { $this->mOrderType = $order; $this->mIndexField = $index[$order]; + $this->mExtraSortFields = isset( $extraSort[$order] ) + ? (array)$extraSort[$order] + : array(); } elseif( is_array( $index ) ) { # First element is the default reset( $index ); list( $this->mOrderType, $this->mIndexField ) = each( $index ); + $this->mExtraSortFields = isset( $extraSort[$this->mOrderType] ) + ? (array)$extraSort[$this->mOrderType] + : array(); } else { # $index is not an array $this->mOrderType = null; $this->mIndexField = $index; + $this->mExtraSortFields = (array)$extraSort; } if( !isset( $this->mDefaultDirection ) ) { @@ -173,13 +192,17 @@ abstract class IndexPager implements Pager { } /** - * Set the offset from an other source than $wgRequest + * Set the offset from an other source than the request + * + * @param $offset Int|String */ function setOffset( $offset ) { $this->mOffset = $offset; } /** - * Set the limit from an other source than $wgRequest + * Set the limit from an other source than the request + * + * @param $limit Int|String */ function setLimit( $limit ) { $this->mLimit = $limit; @@ -269,11 +292,16 @@ abstract class IndexPager implements Pager { $conds = isset( $info['conds'] ) ? $info['conds'] : array(); $options = isset( $info['options'] ) ? $info['options'] : array(); $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array(); + $sortColumns = array_merge( array( $this->mIndexField ), $this->mExtraSortFields ); if ( $descending ) { - $options['ORDER BY'] = $this->mIndexField; + $options['ORDER BY'] = implode( ',', $sortColumns ); $operator = '>'; } else { - $options['ORDER BY'] = $this->mIndexField . ' DESC'; + $orderBy = array(); + foreach ( $sortColumns as $col ) { + $orderBy[] = $col . ' DESC'; + } + $options['ORDER BY'] = implode( ',', $orderBy ); $operator = '<'; } if ( $offset != '' ) { @@ -297,10 +325,16 @@ abstract class IndexPager implements Pager { * * @return String */ - function getBody() { + public function getBody() { if ( !$this->mQueryDone ) { $this->doQuery(); } + + if ( $this->mResult->numRows() ) { + # Do any special query batches before display + $this->doBatchLookups(); + } + # Don't use any extra rows returned by the query $numRows = min( $this->mResult->numRows(), $this->mLimit ); @@ -348,22 +382,30 @@ abstract class IndexPager implements Pager { if( $type ) { $attrs['class'] = "mw-{$type}link"; } - return $this->getSkin()->link( + return Linker::linkKnown( $this->getTitle(), $text, $attrs, - $query + $this->getDefaultQuery(), - array( 'noclasses', 'known' ) + $query + $this->getDefaultQuery() ); } /** + * Called from getBody(), before getStartBody() is called and + * after doQuery() was called. This will be called only if there + * are rows in the result set. + * + * @return void + */ + protected function doBatchLookups() {} + + /** * Hook into getBody(), allows text to be inserted at the start. This * will be called even if there are no rows in the result set. * * @return String */ - function getStartBody() { + protected function getStartBody() { return ''; } @@ -372,7 +414,7 @@ abstract class IndexPager implements Pager { * * @return String */ - function getEndBody() { + protected function getEndBody() { return ''; } @@ -382,34 +424,11 @@ abstract class IndexPager implements Pager { * * @return String */ - function getEmptyBody() { + protected function getEmptyBody() { return ''; } /** - * Title used for self-links. Override this if you want to be able to - * use a title other than $wgTitle - * - * @return Title object - */ - function getTitle() { - return $GLOBALS['wgTitle']; - } - - /** - * Get the current skin. This can be overridden if necessary. - * - * @return Skin object - */ - function getSkin() { - if ( !isset( $this->mSkin ) ) { - global $wgUser; - $this->mSkin = $wgUser->getSkin(); - } - return $this->mSkin; - } - - /** * Get an array of query parameters that should be put into self-links. * By default, all parameters passed in the URL are used, except for a * short blacklist. @@ -417,10 +436,8 @@ abstract class IndexPager implements Pager { * @return Associative array */ function getDefaultQuery() { - global $wgRequest; - if ( !isset( $this->mDefaultQuery ) ) { - $this->mDefaultQuery = $wgRequest->getQueryValues(); + $this->mDefaultQuery = $this->getRequest()->getQueryValues(); unset( $this->mDefaultQuery['title'] ); unset( $this->mDefaultQuery['dir'] ); unset( $this->mDefaultQuery['offset'] ); @@ -455,7 +472,7 @@ abstract class IndexPager implements Pager { } # Don't announce the limit everywhere if it's the default - $urlLimit = $this->mLimit == $this->mDefaultLimit ? '' : $this->mLimit; + $urlLimit = $this->mLimit == $this->mDefaultLimit ? null : $this->mLimit; if ( $this->mIsFirst ) { $prev = false; @@ -502,6 +519,8 @@ abstract class IndexPager implements Pager { * $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays * of HTML. * + * @param $linkTexts Array + * @param $disabledTexts Array * @return Array */ function getPagingLinks( $linkTexts, $disabledTexts = array() ) { @@ -524,7 +543,6 @@ abstract class IndexPager implements Pager { } function getLimitLinks() { - global $wgLang; $links = array(); if ( $this->mIsBackwards ) { $offset = $this->mPastTheEndIndex; @@ -533,7 +551,7 @@ abstract class IndexPager implements Pager { } foreach ( $this->mLimitsShown as $limit ) { $links[] = $this->makeLink( - $wgLang->formatNum( $limit ), + $this->getLanguage()->formatNum( $limit ), array( 'offset' => $offset, 'limit' => $limit ), 'num' ); @@ -574,10 +592,30 @@ abstract class IndexPager implements Pager { * * Needless to say, it's really not a good idea to use a non-unique index * for this! That won't page right. + * + * @return string|Array */ abstract function getIndexField(); /** + * This function should be overridden to return the names of secondary columns + * to order by in addition to the column in getIndexField(). These fields will + * not be used in the pager offset or in any links for users. + * + * If getIndexField() returns an array of 'querykey' => 'indexfield' pairs then + * this must return a corresponding array of 'querykey' => array( fields...) pairs + * in order for a request with &count=querykey to use array( fields...) to sort. + * + * This is useful for pagers that GROUP BY a unique column (say page_id) + * and ORDER BY another (say page_len). Using GROUP BY and ORDER BY both on + * page_len,page_id avoids temp tables (given a page_len index). This would + * also work if page_id was non-unique but we had a page_len,page_id index. + * + * @return Array + */ + protected function getExtraSortFields() { return array(); } + + /** * Return the default sorting direction: false for ascending, true for de- * scending. You can also have an associative array of ordertype => dir, * if multiple order types are supported. In this case getIndexField() @@ -605,30 +643,33 @@ abstract class IndexPager implements Pager { * @ingroup Pager */ abstract class AlphabeticPager extends IndexPager { + /** * Shamelessly stolen bits from ReverseChronologicalPager, * didn't want to do class magic as may be still revamped + * + * @return String HTML */ function getNavigationBar() { - global $wgLang; - if ( !$this->isNavigationBarShown() ) return ''; if( isset( $this->mNavigationBar ) ) { return $this->mNavigationBar; } + $lang = $this->getLanguage(); + $opts = array( 'parsemag', 'escapenoentities' ); $linkTexts = array( 'prev' => wfMsgExt( 'prevn', $opts, - $wgLang->formatNum( $this->mLimit ) + $lang->formatNum( $this->mLimit ) ), 'next' => wfMsgExt( 'nextn', $opts, - $wgLang->formatNum($this->mLimit ) + $lang->formatNum($this->mLimit ) ), 'first' => wfMsgExt( 'page_first', $opts ), 'last' => wfMsgExt( 'page_last', $opts ) @@ -636,10 +677,10 @@ abstract class AlphabeticPager extends IndexPager { $pagingLinks = $this->getPagingLinks( $linkTexts ); $limitLinks = $this->getLimitLinks(); - $limits = $wgLang->pipeList( $limitLinks ); + $limits = $lang->pipeList( $limitLinks ); $this->mNavigationBar = - "(" . $wgLang->pipeList( + "(" . $lang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " . @@ -700,13 +741,7 @@ abstract class ReverseChronologicalPager extends IndexPager { public $mYear; public $mMonth; - function __construct() { - parent::__construct(); - } - function getNavigationBar() { - global $wgLang; - if ( !$this->isNavigationBarShown() ) { return ''; } @@ -714,7 +749,8 @@ abstract class ReverseChronologicalPager extends IndexPager { if ( isset( $this->mNavigationBar ) ) { return $this->mNavigationBar; } - $nicenumber = $wgLang->formatNum( $this->mLimit ); + + $nicenumber = $this->getLanguage()->formatNum( $this->mLimit ); $linkTexts = array( 'prev' => wfMsgExt( 'pager-newer-n', @@ -732,7 +768,7 @@ abstract class ReverseChronologicalPager extends IndexPager { $pagingLinks = $this->getPagingLinks( $linkTexts ); $limitLinks = $this->getLimitLinks(); - $limits = $wgLang->pipeList( $limitLinks ); + $limits = $this->getLanguage()->pipeList( $limitLinks ); $this->mNavigationBar = "({$pagingLinks['first']}" . wfMsgExt( 'pipe-separator' , 'escapenoentities' ) . @@ -746,11 +782,11 @@ abstract class ReverseChronologicalPager extends IndexPager { } function getDateCond( $year, $month ) { - $year = intval($year); - $month = intval($month); + $year = intval( $year ); + $month = intval( $month ); // Basic validity checks $this->mYear = $year > 0 ? $year : false; - $this->mMonth = ($month > 0 && $month < 13) ? $month : false; + $this->mMonth = ( $month > 0 && $month < 13 ) ? $month : false; // Given an optional year and month, we need to generate a timestamp // to use as "WHERE rev_timestamp <= result" // Examples: year = 2006 equals < 20070101 (+000000) @@ -801,15 +837,18 @@ abstract class TablePager extends IndexPager { var $mSort; var $mCurrentRow; - function __construct() { - global $wgRequest; - $this->mSort = $wgRequest->getText( 'sort' ); + function __construct( IContextSource $context = null ) { + if ( $context ) { + $this->setContext( $context ); + } + + $this->mSort = $this->getRequest()->getText( 'sort' ); if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) ) { $this->mSort = $this->getDefaultSort(); } - if ( $wgRequest->getBool( 'asc' ) ) { + if ( $this->getRequest()->getBool( 'asc' ) ) { $this->mDefaultDirection = false; - } elseif ( $wgRequest->getBool( 'desc' ) ) { + } elseif ( $this->getRequest()->getBool( 'desc' ) ) { $this->mDefaultDirection = true; } /* Else leave it at whatever the class default is */ @@ -821,7 +860,7 @@ abstract class TablePager extends IndexPager { $tableClass = htmlspecialchars( $this->getTableClass() ); $sortClass = htmlspecialchars( $this->getSortHeaderClass() ); - $s = "<table style='border:1;' class=\"$tableClass\"><thead><tr>\n"; + $s = "<table style='border:1;' class=\"mw-datatable $tableClass\"><thead><tr>\n"; $fields = $this->getFieldNames(); # Make table header @@ -872,9 +911,13 @@ abstract class TablePager extends IndexPager { return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n"; } + /** + * @param $row Array + * @return String HTML + */ function formatRow( $row ) { $this->mCurrentRow = $row; # In case formatValue etc need to know - $s = Xml::openElement( 'tr', $this->getRowAttrs($row) ); + $s = Xml::openElement( 'tr', $this->getRowAttrs( $row ) ); $fieldNames = $this->getFieldNames(); foreach ( $fieldNames as $field => $name ) { $value = isset( $row->$field ) ? $row->$field : null; @@ -902,7 +945,7 @@ abstract class TablePager extends IndexPager { * Get attributes to be applied to the given row. * * @param $row Object: the database result row - * @return Associative array + * @return Array of <attr> => <value> */ function getRowAttrs( $row ) { $class = $this->getRowClass( $row ); @@ -919,9 +962,9 @@ abstract class TablePager extends IndexPager { * take this as an excuse to hardcode styles; use classes and * CSS instead. Row context is available in $this->mCurrentRow * - * @param $field The column - * @param $value The cell contents - * @return Associative array + * @param $field String The column + * @param $value String The cell contents + * @return Array of attr => value */ function getCellAttrs( $field, $value ) { return array( 'class' => 'TablePager_col_' . $field ); @@ -945,9 +988,10 @@ abstract class TablePager extends IndexPager { /** * A navigation bar with images + * @return String HTML */ function getNavigationBar() { - global $wgStylePath, $wgLang; + global $wgStylePath; if ( !$this->isNavigationBarShown() ) { return ''; @@ -972,7 +1016,7 @@ abstract class TablePager extends IndexPager { 'next' => 'arrow_disabled_right_25.png', 'last' => 'arrow_disabled_last_25.png', ); - if( $wgLang->isRTL() ) { + if( $this->getLanguage()->isRTL() ) { $keys = array_keys( $labels ); $images = array_combine( $keys, array_reverse( $images ) ); $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) ); @@ -1003,8 +1047,6 @@ abstract class TablePager extends IndexPager { * @return String: HTML fragment */ function getLimitSelect() { - global $wgLang; - # Add the current limit from the query string # to avoid that the limit is lost after clicking Go next time if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) { @@ -1018,7 +1060,7 @@ abstract class TablePager extends IndexPager { # will be a string. if( is_int( $value ) ){ $limit = $value; - $text = $wgLang->formatNum( $limit ); + $text = $this->getLanguage()->formatNum( $limit ); } else { $limit = $key; $text = $value; @@ -1034,13 +1076,12 @@ abstract class TablePager extends IndexPager { * Resubmits all defined elements of the query string, except for a * blacklist, passed in the $blacklist parameter. * + * @param $blacklist Array parameters from the request query which should not be resubmitted * @return String: HTML fragment */ function getHiddenFields( $blacklist = array() ) { - global $wgRequest; - $blacklist = (array)$blacklist; - $query = $wgRequest->getQueryValues(); + $query = $this->getRequest()->getQueryValues(); foreach ( $blacklist as $name ) { unset( $query[$name] ); } @@ -1112,6 +1153,8 @@ abstract class TablePager extends IndexPager { * An array mapping database field names to a textual description of the * field name, for use in the table header. The description should be plain * text, it will be HTML-escaped later. + * + * @return Array */ abstract function getFieldNames(); } |