<?php
/**
- * @defgroup Pager Pager
+ * Efficient paging for SQL queries.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Pager
*/
+/**
+ * @defgroup Pager Pager
+ */
+
/**
* Basic pager interface.
* @ingroup 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;
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;
/** 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.
+ *
+ * @var ResultWrapper
*/
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
$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 ) ) {
* has been kept minimal to make it overridable if necessary, to allow for
* result sets formed from multiple DB queries.
*/
- function doQuery() {
+ public function doQuery() {
# Use the child class name for profiling
$fname = __METHOD__ . ' (' . get_class( $this ) . ')';
wfProfileIn( $fname );
}
/**
- * 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;
# Remove any table prefix from index field
$parts = explode( '.', $this->mIndexField );
$indexColumn = end( $parts );
-
+
$row = $res->fetchRow();
$firstIndex = $row[$indexColumn];
$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'] = $sortColumns;
$operator = '>';
} else {
- $options['ORDER BY'] = $this->mIndexField . ' DESC';
+ $orderBy = array();
+ foreach ( $sortColumns as $col ) {
+ $orderBy[] = $col . ' DESC';
+ }
+ $options['ORDER BY'] = $orderBy;
$operator = '<';
}
if ( $offset != '' ) {
*
* @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 );
* @param $text String: text displayed on the link
* @param $query Array: associative array of paramter to be in the query string
* @param $type String: value of the "rel" attribute
+ *
* @return String: HTML fragment
*/
- function makeLink($text, $query = null, $type=null) {
+ function makeLink( $text, array $query = null, $type = null ) {
if ( $query === null ) {
return $text;
}
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 '';
}
*
* @return String
*/
- function getEndBody() {
+ protected function getEndBody() {
return '';
}
*
* @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.
*
- * @return Associative array
+ * @return array Associative array
*/
function getDefaultQuery() {
if ( !isset( $this->mDefaultQuery ) ) {
- $this->mDefaultQuery = $_GET;
+ $this->mDefaultQuery = $this->getRequest()->getQueryValues();
unset( $this->mDefaultQuery['title'] );
unset( $this->mDefaultQuery['dir'] );
unset( $this->mDefaultQuery['offset'] );
}
# 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;
* $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() ) {
$queries = $this->getPagingQueries();
$links = array();
+
foreach ( $queries as $type => $query ) {
if ( $query !== false ) {
$links[$type] = $this->makeLink(
$links[$type] = $linkTexts[$type];
}
}
+
return $links;
}
function getLimitLinks() {
- global $wgLang;
$links = array();
if ( $this->mIsBackwards ) {
$offset = $this->mPastTheEndIndex;
}
foreach ( $this->mLimitsShown as $limit ) {
$links[] = $this->makeLink(
- $wgLang->formatNum( $limit ),
+ $this->getLanguage()->formatNum( $limit ),
array( 'offset' => $offset, 'limit' => $limit ),
'num'
);
*
* 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,
* @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 ( !$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 )
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
- $limits = $wgLang->pipeList( $limitLinks );
+ $limits = $lang->pipeList( $limitLinks );
- $this->mNavigationBar =
- "(" . $wgLang->pipeList(
+ $this->mNavigationBar = wfMessage( 'parentheses' )->rawParams(
+ $lang->pipeList(
array( $pagingLinks['first'],
- $pagingLinks['last'] )
- ) . ") " .
+ $pagingLinks['last'] )
+ ) )->escaped() . " " .
wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
- $pagingLinks['next'], $limits );
+ $pagingLinks['next'], $limits );
if( !is_array( $this->getIndexField() ) ) {
# Early return to avoid undue nesting
}
if( $extra !== '' ) {
- $this->mNavigationBar .= " ($extra)";
+ $extra = ' ' . wfMessage( 'parentheses' )->rawParams( $extra )->escaped();
+ $this->mNavigationBar .= $extra;
}
return $this->mNavigationBar;
public $mYear;
public $mMonth;
- function __construct() {
- parent::__construct();
- }
-
function getNavigationBar() {
- global $wgLang;
-
- if ( !$this->isNavigationBarShown() ) return '';
+ if ( !$this->isNavigationBarShown() ) {
+ return '';
+ }
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',
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
- $limits = $wgLang->pipeList( $limitLinks );
-
- $this->mNavigationBar = "({$pagingLinks['first']}" .
+ $limits = $this->getLanguage()->pipeList( $limitLinks );
+ $firstLastLinks = wfMessage( 'parentheses' )->rawParams( "{$pagingLinks['first']}" .
wfMsgExt( 'pipe-separator' , 'escapenoentities' ) .
- "{$pagingLinks['last']}) " .
+ "{$pagingLinks['last']}" )->escaped();
+
+ $this->mNavigationBar = $firstLastLinks . ' ' .
wfMsgHTML(
'viewprevnext',
$pagingLinks['prev'], $pagingLinks['next'],
$limits
);
+
return $this->mNavigationBar;
}
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)
if ( !$this->mYear && !$this->mMonth ) {
return;
}
+
if ( $this->mYear ) {
$year = $this->mYear;
} else {
$year--;
}
}
+
if ( $this->mMonth ) {
$month = $this->mMonth + 1;
// For December, we want January 1 of the next year
$month = 1;
$year++;
}
+
// Y2K38 bug
if ( $year > 2032 ) {
$year = 2032;
}
+
$ymd = (int)sprintf( "%04d%02d01", $year, $month );
+
if ( $ymd > 20320101 ) {
$ymd = 20320101;
}
+
$this->mOffset = $this->mDb->timestamp( "${ymd}000000" );
}
}
var $mSort;
var $mCurrentRow;
- function __construct() {
- global $wgRequest;
- $this->mSort = $wgRequest->getText( 'sort' );
+ public 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 */
parent::__construct();
}
+ /**
+ * @protected
+ * @return string
+ */
function getStartBody() {
global $wgStylePath;
$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
$image = htmlspecialchars( "$wgStylePath/common/images/$image" );
$link = $this->makeLink(
"<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
- htmlspecialchars( $name ), $query );
+ htmlspecialchars( $name ), $query );
$s .= "<th class=\"$sortClass\">$link</th>\n";
} else {
$s .= '<th>' . $this->makeLink( htmlspecialchars( $name ), $query ) . "</th>\n";
return $s;
}
+ /**
+ * @protected
+ * @return string
+ */
function getEndBody() {
return "</tbody></table>\n";
}
+ /**
+ * @protected
+ * @return string
+ */
function getEmptyBody() {
$colspan = count( $this->getFieldNames() );
$msgEmpty = wfMsgHtml( 'table_pager_empty' );
return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
}
+ /**
+ * @protected
+ * @param stdClass $row
+ * @return String HTML
+ */
function formatRow( $row ) {
- $this->mCurrentRow = $row; # In case formatValue etc need to know
- $s = Xml::openElement( 'tr', $this->getRowAttrs($row) );
+ $this->mCurrentRow = $row; // In case formatValue etc need to know
+ $s = Xml::openElement( 'tr', $this->getRowAttrs( $row ) );
$fieldNames = $this->getFieldNames();
+
foreach ( $fieldNames as $field => $name ) {
$value = isset( $row->$field ) ? $row->$field : null;
$formatted = strval( $this->formatValue( $field, $value ) );
+
if ( $formatted == '' ) {
$formatted = ' ';
}
+
$s .= Xml::tags( 'td', $this->getCellAttrs( $field, $value ), $formatted );
}
+
$s .= "</tr>\n";
+
return $s;
}
/**
* Get a class name to be applied to the given row.
*
+ * @protected
+ *
* @param $row Object: the database result row
* @return String
*/
/**
* Get attributes to be applied to the given row.
*
+ * @protected
+ *
* @param $row Object: the database result row
- * @return Associative array
+ * @return Array of <attr> => <value>
*/
function getRowAttrs( $row ) {
$class = $this->getRowClass( $row );
* 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
+ * @protected
+ *
+ * @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 );
}
+ /**
+ * @protected
+ * @return string
+ */
function getIndexField() {
return $this->mSort;
}
+ /**
+ * @protected
+ * @return string
+ */
function getTableClass() {
return 'TablePager';
}
+ /**
+ * @protected
+ * @return string
+ */
function getNavClass() {
return 'TablePager_nav';
}
+ /**
+ * @protected
+ * @return string
+ */
function getSortHeaderClass() {
return 'TablePager_sort';
}
/**
* A navigation bar with images
+ * @return String HTML
*/
- function getNavigationBar() {
- global $wgStylePath, $wgContLang;
+ public function getNavigationBar() {
+ global $wgStylePath;
if ( !$this->isNavigationBarShown() ) {
return '';
'next' => 'arrow_disabled_right_25.png',
'last' => 'arrow_disabled_last_25.png',
);
- if( $wgContLang->isRTL() ) {
+ if( $this->getLanguage()->isRTL() ) {
$keys = array_keys( $labels );
$images = array_combine( $keys, array_reverse( $images ) );
$disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
*
* @return String: HTML fragment
*/
- function getLimitSelect() {
- global $wgLang;
-
+ public function getLimitSelect() {
# 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 ) ) {
# will be a string.
if( is_int( $value ) ){
$limit = $value;
- $text = $wgLang->formatNum( $limit );
+ $text = $this->getLanguage()->formatNum( $limit );
} else {
$limit = $key;
$text = $value;
/**
* Get <input type="hidden"> elements for use in a method="get" form.
- * Resubmits all defined elements of the $_GET array, except for a
+ * 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() ) {
$blacklist = (array)$blacklist;
- $query = $_GET;
+ $query = $this->getRequest()->getQueryValues();
foreach ( $blacklist as $name ) {
unset( $query[$name] );
}
* The current result row is available as $this->mCurrentRow, in case you
* need more context.
*
+ * @protected
+ *
* @param $name String: the database field name
* @param $value String: the value retrieved from the database
*/
abstract function formatValue( $name, $value );
/**
- * The database field name used as a default sort order
+ * The database field name used as a default sort order.
+ *
+ * @protected
+ *
+ * @return string
*/
abstract function getDefaultSort();
* 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();
}
dépôts / lhc / web / wiklou.git / blobdiff