<?php
+/**
+ * @defgroup Pager Pager
+ *
+ * @file
+ * @ingroup Pager
+ */
/**
* Basic pager interface.
- * @addtogroup Pager
+ * @ingroup Pager
*/
interface Pager {
function getNavigationBar();
}
/**
- * IndexPager is an efficient pager which uses a (roughly unique) index in the
- * data set to implement paging, rather than a "LIMIT offset,limit" clause.
+ * IndexPager is an efficient pager which uses a (roughly unique) index in the
+ * data set to implement paging, rather than a "LIMIT offset,limit" clause.
* In MySQL, such a limit/offset clause requires counting through the
* specified number of offset rows to find the desired data, which can be
* expensive for large offsets.
- *
+ *
* ReverseChronologicalPager is a child class of the abstract IndexPager, and
* contains some formatting and display code which is specific to the use of
* timestamps as indexes. Here is a synopsis of its operation:
- *
+ *
* * The query is specified by the offset, limit and direction (dir)
- * parameters, in addition to any subclass-specific parameters.
+ * parameters, in addition to any subclass-specific parameters.
* * The offset is the non-inclusive start of the DB query. A row with an
* index value equal to the offset will never be shown.
* * The query may either be done backwards, where the rows are returned by
* user, or forwards. This is specified by the "dir" parameter, dir=prev
* means backwards, anything else means forwards. The offset value
* specifies the start of the database result set, which may be either
- * the start or end of the displayed data set. This allows "previous"
+ * the start or end of the displayed data set. This allows "previous"
* links to be implemented without knowledge of the index value at the
- * start of the previous page.
+ * start of the previous page.
* * An additional row beyond the user-specified limit is always requested.
* This allows us to tell whether we should display a "next" link in the
* case of forwards mode, or a "previous" link in the case of backwards
* mode. Determining whether to display the other link (the one for the
* page before the start of the database result set) can be done
- * heuristically by examining the offset.
+ * heuristically by examining the offset.
*
* * An empty offset indicates that the offset condition should be omitted
* from the query. This naturally produces either the first page or the
- * last page depending on the dir parameter.
+ * last page depending on the dir parameter.
*
* Subclassing the pager to implement concrete functionality should be fairly
- * simple, please see the examples in PageHistory.php and
+ * simple, please see the examples in PageHistory.php and
* SpecialIpblocklist.php. You just need to override formatRow(),
* getQueryInfo() and getIndexField(). Don't forget to call the parent
* constructor if you override it.
*
- * @addtogroup Pager
+ * @ingroup Pager
*/
abstract class IndexPager implements Pager {
public $mRequest;
/** For pages that support multiple types of ordering, which one to use. */
protected $mOrderType;
/**
- * $mDefaultDirection gives the direction to use when sorting results:
+ * $mDefaultDirection gives the direction to use when sorting results:
* false for ascending, true for descending. If $mIsBackwards is set, we
* start from the opposite end, but we still sort the page itself according
* to $mDefaultDirection. E.g., if $mDefaultDirection is false but we're
public function __construct() {
global $wgRequest, $wgUser;
$this->mRequest = $wgRequest;
-
+
# NB: the offset is quoted, not validated. It is treated as an
# arbitrary string to support the widest variety of index types. Be
# careful outputting it into HTML!
}
/**
- * Do the query, using information from the object context. This function
- * has been kept minimal to make it overridable if necessary, to allow for
+ * Do the query, using information from the object context. This function
+ * has been kept minimal to make it overridable if necessary, to allow for
* result sets formed from multiple DB queries.
*/
function doQuery() {
$this->mResult = $this->reallyDoQuery( $this->mOffset, $queryLimit, $descending );
$this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
$this->mQueryDone = true;
-
+
$this->preprocessResults( $this->mResult );
$this->mResult->rewind(); // Paranoia
wfProfileOut( $fname );
}
+
+ /**
+ * Return the result wrapper.
+ */
+ function getResult() {
+ return $this->mResult;
+ }
+
+ /**
+ * Set the offset from an other source than $wgRequest
+ */
+ function setOffset( $offset ) {
+ $this->mOffset = $offset;
+ }
+ /**
+ * Set the limit from an other source than $wgRequest
+ */
+ function setLimit( $limit ) {
+ $this->mLimit = $limit;
+ }
/**
- * Extract some useful data from the result object for use by
+ * Extract some useful data from the result object for use by
* the navigation bar, put it into $this
*/
function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
$fields = $info['fields'];
$conds = isset( $info['conds'] ) ? $info['conds'] : array();
$options = isset( $info['options'] ) ? $info['options'] : array();
+ $join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
if ( $descending ) {
$options['ORDER BY'] = $this->mIndexField;
$operator = '>';
$conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
}
$options['LIMIT'] = intval( $limit );
- $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options );
+ $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
return new ResultWrapper( $this->mDb, $res );
}
protected function preprocessResults( $result ) {}
/**
- * Get the formatted result list. Calls getStartBody(), formatRow() and
+ * Get the formatted result list. Calls getStartBody(), formatRow() and
* getEndBody(), concatenates the results and returns them.
*/
function getBody() {
/**
* Make a self-link
*/
- function makeLink($text, $query = null) {
+ function makeLink($text, $query = null, $type=null) {
if ( $query === null ) {
return $text;
}
- return $this->getSkin()->makeKnownLinkObj( $this->getTitle(), $text,
- wfArrayToCGI( $query, $this->getDefaultQuery() ) );
+
+ $attrs = array();
+ if( in_array( $type, array( 'first', 'prev', 'next', 'last' ) ) ) {
+ # HTML5 rel attributes
+ $attrs['rel'] = $type;
+ }
+
+ if( $type ) {
+ $attrs['class'] = "mw-{$type}link";
+ }
+ return $this->getSkin()->link( $this->getTitle(), $text,
+ $attrs, $query + $this->getDefaultQuery(), array('noclasses','known') );
}
/**
- * Hook into getBody(), allows text to be inserted at the start. This
+ * 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.
*/
function getStartBody() {
}
/**
- * Hook into getBody(), for the bit between the start and the
+ * Hook into getBody(), for the bit between the start and the
* end when there are no rows
*/
function getEmptyBody() {
return '';
}
-
+
/**
- * Title used for self-links. Override this if you want to be able to
+ * Title used for self-links. Override this if you want to be able to
* use a title other than $wgTitle
*/
function getTitle() {
}
/**
- * 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
+ * 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.
*/
function getDefaultQuery() {
unset( $this->mDefaultQuery['offset'] );
unset( $this->mDefaultQuery['limit'] );
unset( $this->mDefaultQuery['order'] );
+ unset( $this->mDefaultQuery['month'] );
+ unset( $this->mDefaultQuery['year'] );
}
return $this->mDefaultQuery;
}
if ( !$this->mQueryDone ) {
$this->doQuery();
}
-
+
# Don't announce the limit everywhere if it's the default
$urlLimit = $this->mLimit == $this->mDefaultLimit ? '' : $this->mLimit;
-
+
if ( $this->mIsFirst ) {
$prev = false;
$first = false;
return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last );
}
+ function isNavigationBarShown() {
+ if ( !$this->mQueryDone ) {
+ $this->doQuery();
+ }
+ // Hide navigation by default if there is nothing to page
+ return !($this->mIsFirst && $this->mIsLast);
+ }
+
/**
* Get paging links. If a link is disabled, the item from $disabledTexts
* will be used. If there is no such item, the unlinked text from
$links = array();
foreach ( $queries as $type => $query ) {
if ( $query !== false ) {
- $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type] );
+ $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type );
} elseif ( isset( $disabledTexts[$type] ) ) {
$links[$type] = $disabledTexts[$type];
} else {
}
foreach ( $this->mLimitsShown as $limit ) {
$links[] = $this->makeLink( $wgLang->formatNum( $limit ),
- array( 'offset' => $offset, 'limit' => $limit ) );
+ array( 'offset' => $offset, 'limit' => $limit ), 'num' );
}
return $links;
}
/**
- * Abstract formatting function. This should return an HTML string
+ * Abstract formatting function. This should return an HTML string
* representing the result row $row. Rows will be concatenated and
* returned by getBody()
*/
abstract function formatRow( $row );
/**
- * This function should be overridden to provide all parameters
- * needed for the main paged query. It returns an associative
+ * This function should be overridden to provide all parameters
+ * needed for the main paged query. It returns an associative
* array with the following elements:
* tables => Table(s) for passing to Database::select()
* fields => Field(s) for passing to Database::select(), may be *
* conds => WHERE conditions
* options => option array
+ * join_conds => JOIN conditions
*/
abstract function getQueryInfo();
/**
* IndexPager with an alphabetic list and a formatted navigation bar
- * @addtogroup Pager
+ * @ingroup Pager
*/
abstract class AlphabeticPager extends IndexPager {
- function __construct() {
- parent::__construct();
- }
-
- /**
+ /**
* Shamelessly stolen bits from ReverseChronologicalPager,
- * didn't want to do class magic as may be still revamped
+ * didn't want to do class magic as may be still revamped
*/
function getNavigationBar() {
global $wgLang;
+ if ( !$this->isNavigationBarShown() ) return '';
+
if( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
+ $opts = array( 'parsemag', 'escapenoentities' );
$linkTexts = array(
- 'prev' => wfMsgHtml( 'prevn', $wgLang->formatNum( $this->mLimit ) ),
- 'next' => wfMsgHtml( 'nextn', $wgLang->formatNum($this->mLimit ) ),
- 'first' => wfMsgHtml( 'page_first' ),
- 'last' => wfMsgHtml( 'page_last' )
+ 'prev' => wfMsgExt( 'prevn', $opts, $wgLang->formatNum( $this->mLimit ) ),
+ 'next' => wfMsgExt( 'nextn', $opts, $wgLang->formatNum($this->mLimit ) ),
+ 'first' => wfMsgExt( 'page_first', $opts ),
+ 'last' => wfMsgExt( 'page_last', $opts )
);
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
- $limits = implode( ' | ', $limitLinks );
+ $limits = $wgLang->pipeList( $limitLinks );
$this->mNavigationBar =
- "({$pagingLinks['first']} | {$pagingLinks['last']}) " .
+ "(" . $wgLang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " .
wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
$pagingLinks['next'], $limits );
if( $first ) {
$first = false;
} else {
- $extra .= ' | ';
+ $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
}
-
+
if( $order == $this->mOrderType ) {
$extra .= wfMsgHTML( $msgs[$order] );
} else {
/**
* IndexPager with a formatted navigation bar
- * @addtogroup Pager
+ * @ingroup Pager
*/
abstract class ReverseChronologicalPager extends IndexPager {
public $mDefaultDirection = true;
+ public $mYear;
+ public $mMonth;
function __construct() {
parent::__construct();
function getNavigationBar() {
global $wgLang;
+ if ( !$this->isNavigationBarShown() ) return '';
+
if ( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
$nicenumber = $wgLang->formatNum( $this->mLimit );
$linkTexts = array(
- 'prev' => wfMsgExt( 'pager-newer-n', array( 'parsemag' ), $nicenumber ),
- 'next' => wfMsgExt( 'pager-older-n', array( 'parsemag' ), $nicenumber ),
+ 'prev' => wfMsgExt( 'pager-newer-n', array( 'parsemag', 'escape' ), $nicenumber ),
+ 'next' => wfMsgExt( 'pager-older-n', array( 'parsemag', 'escape' ), $nicenumber ),
'first' => wfMsgHtml( 'histlast' ),
'last' => wfMsgHtml( 'histfirst' )
);
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
- $limits = implode( ' | ', $limitLinks );
+ $limits = $wgLang->pipeList( $limitLinks );
- $this->mNavigationBar = "({$pagingLinks['first']} | {$pagingLinks['last']}) " .
+ $this->mNavigationBar = "({$pagingLinks['first']}" . wfMsgExt( 'pipe-separator' , 'escapenoentities' ) . "{$pagingLinks['last']}) " .
wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits);
return $this->mNavigationBar;
}
+
+ function getDateCond( $year, $month ) {
+ $year = intval($year);
+ $month = intval($month);
+ // Basic validity checks
+ $this->mYear = $year > 0 ? $year : 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)
+ // year=2005, month=1 equals < 20050201
+ // year=2005, month=12 equals < 20060101
+ if ( !$this->mYear && !$this->mMonth ) {
+ return;
+ }
+ if ( $this->mYear ) {
+ $year = $this->mYear;
+ } else {
+ // If no year given, assume the current one
+ $year = gmdate( 'Y' );
+ // If this month hasn't happened yet this year, go back to last year's month
+ if( $this->mMonth > gmdate( 'n' ) ) {
+ $year--;
+ }
+ }
+ if ( $this->mMonth ) {
+ $month = $this->mMonth + 1;
+ // For December, we want January 1 of the next year
+ if ($month > 12) {
+ $month = 1;
+ $year++;
+ }
+ } else {
+ // No month implies we want up to the end of the year in question
+ $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" );
+ }
}
/**
* Table-based display with a user-selectable sort order
- * @addtogroup Pager
+ * @ingroup Pager
*/
abstract class TablePager extends IndexPager {
var $mSort;
global $wgStylePath;
$tableClass = htmlspecialchars( $this->getTableClass() );
$sortClass = htmlspecialchars( $this->getSortHeaderClass() );
-
+
$s = "<table border='1' class=\"$tableClass\"><thead><tr>\n";
$fields = $this->getFieldNames();
$alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
}
$image = htmlspecialchars( "$wgStylePath/common/images/$image" );
- $link = $this->makeLink(
+ $link = $this->makeLink(
"<img width=\"12\" height=\"12\" alt=\"$alt\" src=\"$image\" />" .
htmlspecialchars( $name ), $query );
$s .= "<th class=\"$sortClass\">$link</th>\n";
}
}
$s .= "</tr></thead><tbody>\n";
- return $s;
+ return $s;
}
function getEndBody() {
}
function formatRow( $row ) {
- $s = "<tr>\n";
+ $this->mCurrentRow = $row; # In case formatValue etc need to know
+ $s = Xml::openElement( 'tr', $this->getRowAttrs($row) );
$fieldNames = $this->getFieldNames();
- $this->mCurrentRow = $row; # In case formatValue needs to know
foreach ( $fieldNames as $field => $name ) {
$value = isset( $row->$field ) ? $row->$field : null;
$formatted = strval( $this->formatValue( $field, $value ) );
if ( $formatted == '' ) {
$formatted = ' ';
}
- $class = 'TablePager_col_' . htmlspecialchars( $field );
- $s .= "<td class=\"$class\">$formatted</td>\n";
+ $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.
+ * @param object $row The database result row
+ */
+ function getRowClass( $row ) {
+ return '';
+ }
+
+ /**
+ * Get attributes to be applied to the given row.
+ * @param object $row The database result row
+ * @return associative array
+ */
+ function getRowAttrs( $row ) {
+ return array( 'class' => $this->getRowClass( $row ) );
+ }
+
+ /**
+ * Get any extra attributes to be applied to the given cell. Don't
+ * 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
+ */
+ function getCellAttrs( $field, $value ) {
+ return array( 'class' => 'TablePager_col_' . $field );
+ }
+
function getIndexField() {
return $this->mSort;
}
*/
function getNavigationBar() {
global $wgStylePath, $wgContLang;
+
+ if ( !$this->isNavigationBarShown() ) return '';
+
$path = "$wgStylePath/common/images";
$labels = array(
'first' => 'table_pager_first',
}
/**
- * Get <input type="hidden"> elements for use in a method="get" form.
- * Resubmits all defined elements of the $_GET array, except for a
+ * Get <input type="hidden"> elements for use in a method="get" form.
+ * Resubmits all defined elements of the $_GET array, except for a
* blacklist, passed in the $blacklist parameter.
*/
function getHiddenFields( $blacklist = array() ) {
* Get a form containing a limit selection dropdown
*/
function getLimitForm() {
+ global $wgScript;
+
# Make the select with some explanatory text
- $url = $this->getTitle()->escapeLocalURL();
$msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
return
- "<form method=\"get\" action=\"$url\">" .
- wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
+ Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) . "\n" .
+ wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
"\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
- $this->getHiddenFields( 'limit' ) .
+ $this->getHiddenFields( array( 'limit' ) ) .
"</form>\n";
}
/**
* Format a table cell. The return value should be HTML, but use an empty
- * string not for empty cells. Do not include the <td> and </td>.
+ * string not for empty cells. Do not include the <td> and </td>.
*
* The current result row is available as $this->mCurrentRow, in case you
* need more context.