<?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
$queryLimit,
$descending
);
+
$this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
$this->mQueryDone = true;
* @param $descending Boolean: query direction, false for ascending, true for descending
* @return ResultWrapper
*/
- function reallyDoQuery( $offset, $limit, $descending ) {
+ public function reallyDoQuery( $offset, $limit, $descending ) {
+ list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo( $offset, $limit, $descending );
+ $result = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
+ return new ResultWrapper( $this->mDb, $result );
+ }
+
+ /**
+ * Build variables to use by the database wrapper.
+ *
+ * @param $offset String: index offset, inclusive
+ * @param $limit Integer: exact query limit
+ * @param $descending Boolean: query direction, false for ascending, true for descending
+ * @return array
+ */
+ protected function buildQueryInfo( $offset, $limit, $descending ) {
$fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
$info = $this->getQueryInfo();
$tables = $info['tables'];
$join_conds = isset( $info['join_conds'] ) ? $info['join_conds'] : array();
$sortColumns = array_merge( array( $this->mIndexField ), $this->mExtraSortFields );
if ( $descending ) {
- $options['ORDER BY'] = implode( ',', $sortColumns );
+ $options['ORDER BY'] = $sortColumns;
$operator = '>';
} else {
$orderBy = array();
foreach ( $sortColumns as $col ) {
$orderBy[] = $col . ' DESC';
}
- $options['ORDER BY'] = implode( ',', $orderBy );
+ $options['ORDER BY'] = $orderBy;
$operator = '<';
}
if ( $offset != '' ) {
$conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset );
}
$options['LIMIT'] = intval( $limit );
- $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
- return new ResultWrapper( $this->mDb, $res );
+ return array( $tables, $fields, $conds, $fname, $options, $join_conds );
}
/**
* @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 Linker::linkKnown(
$this->getTitle(),
$text,
* 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 ) ) {
}
# 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;
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;
}
* @return String HTML
*/
function getNavigationBar() {
- 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,
- $lang->formatNum( $this->mLimit )
- ),
- 'next' => wfMsgExt(
- 'nextn',
- $opts,
- $lang->formatNum($this->mLimit )
- ),
- 'first' => wfMsgExt( 'page_first', $opts ),
- 'last' => wfMsgExt( 'page_last', $opts )
+ 'prev' => $this->msg( 'prevn' )->numParams( $this->mLimit )->escaped(),
+ 'next' => $this->msg( 'nextn' )->numParams( $this->mLimit )->escaped(),
+ 'first' => $this->msg( 'page_first' )->escaped(),
+ 'last' => $this->msg( 'page_last' )->escaped()
);
+ $lang = $this->getLanguage();
+
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
$limits = $lang->pipeList( $limitLinks );
- $this->mNavigationBar =
- "(" . $lang->pipeList(
- array( $pagingLinks['first'],
- $pagingLinks['last'] )
- ) . ") " .
- wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
- $pagingLinks['next'], $limits );
+ $this->mNavigationBar = $this->msg( 'parentheses' )->rawParams(
+ $lang->pipeList( array( $pagingLinks['first'],
+ $pagingLinks['last'] ) ) )->escaped() . " " .
+ $this->msg( 'viewprevnext' )->rawParams( $pagingLinks['prev'],
+ $pagingLinks['next'], $limits )->escaped();
if( !is_array( $this->getIndexField() ) ) {
# Early return to avoid undue nesting
if( $first ) {
$first = false;
} else {
- $extra .= wfMsgExt( 'pipe-separator' , 'escapenoentities' );
+ $extra .= $this->msg( 'pipe-separator' )->escaped();
}
if( $order == $this->mOrderType ) {
- $extra .= wfMsgHTML( $msgs[$order] );
+ $extra .= $this->msg( $msgs[$order] )->escaped();
} else {
$extra .= $this->makeLink(
- wfMsgHTML( $msgs[$order] ),
+ $this->msg( $msgs[$order] )->escaped(),
array( 'order' => $order )
);
}
}
if( $extra !== '' ) {
- $this->mNavigationBar .= " ($extra)";
+ $extra = ' ' . $this->msg( 'parentheses' )->rawParams( $extra )->escaped();
+ $this->mNavigationBar .= $extra;
}
return $this->mNavigationBar;
return $this->mNavigationBar;
}
- $nicenumber = $this->getLanguage()->formatNum( $this->mLimit );
$linkTexts = array(
- 'prev' => wfMsgExt(
- 'pager-newer-n',
- array( 'parsemag', 'escape' ),
- $nicenumber
- ),
- 'next' => wfMsgExt(
- 'pager-older-n',
- array( 'parsemag', 'escape' ),
- $nicenumber
- ),
- 'first' => wfMsgHtml( 'histlast' ),
- 'last' => wfMsgHtml( 'histfirst' )
+ 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
+ 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
+ 'first' => $this->msg( 'histlast' )->escaped(),
+ 'last' => $this->msg( 'histfirst' )->escaped()
);
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
$limits = $this->getLanguage()->pipeList( $limitLinks );
+ $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" .
+ $this->msg( 'pipe-separator' )->escaped() .
+ "{$pagingLinks['last']}" )->escaped();
+
+ $this->mNavigationBar = $firstLastLinks . ' ' .
+ $this->msg( 'viewprevnext' )->rawParams(
+ $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped();
- $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);
+ $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( IContextSource $context = null ) {
+ public function __construct( IContextSource $context = null ) {
if ( $context ) {
$this->setContext( $context );
}
parent::__construct();
}
+ /**
+ * @protected
+ * @return string
+ */
function getStartBody() {
global $wgStylePath;
$tableClass = htmlspecialchars( $this->getTableClass() );
$image = 'Arr_d.png';
$query['asc'] = '1';
$query['desc'] = '';
- $alt = htmlspecialchars( wfMsg( 'descending_abbrev' ) );
+ $alt = $this->msg( 'descending_abbrev' )->escaped();
} else {
# Ascending
$image = 'Arr_u.png';
$query['asc'] = '';
$query['desc'] = '1';
- $alt = htmlspecialchars( wfMsg( 'ascending_abbrev' ) );
+ $alt = $this->msg( 'ascending_abbrev' )->escaped();
}
$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' );
+ $msgEmpty = $this->msg( 'table_pager_empty' )->escaped();
return "<tr><td colspan=\"$colspan\">$msgEmpty</td></tr>\n";
}
/**
- * @param $row Array
+ * @protected
+ * @param stdClass $row
* @return String HTML
*/
function formatRow( $row ) {
- $this->mCurrentRow = $row; # In case formatValue etc need to know
+ $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 Array of <attr> => <value>
*/
* take this as an excuse to hardcode styles; use classes and
* CSS instead. Row context is available in $this->mCurrentRow
*
+ * @protected
+ *
* @param $field String The column
* @param $value String The cell contents
* @return Array of attr => 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() {
+ public function getNavigationBar() {
global $wgStylePath;
if ( !$this->isNavigationBarShown() ) {
$linkTexts = array();
$disabledTexts = array();
foreach ( $labels as $type => $label ) {
- $msgLabel = wfMsgHtml( $label );
+ $msgLabel = $this->msg( $label )->escaped();
$linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
$disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
}
*
* @return String: HTML fragment
*/
- function getLimitSelect() {
+ 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 ) ) {
*/
function getLimitDropdown() {
# Make the select with some explanatory text
- $msgSubmit = wfMsgHtml( 'table_pager_limit_submit' );
+ $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();
- return wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
+ return $this->msg( 'table_pager_limit' )
+ ->rawParams( $this->getLimitSelect() )->escaped() .
"\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
$this->getHiddenFields( array( 'limit' ) );
}
* 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();
dépôts / lhc / web / wiklou.git / blobdiff