* 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 HistoryPage.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.
public $mPastTheEndRow;
/**
- * The index to actually be used for ordering. This is a single string e-
- * ven if multiple orderings are supported.
+ * The index to actually be used for ordering. This is a single string
+ * even if multiple orderings are supported.
*/
protected $mIndexField;
- /** For pages that support multiple types of ordering, which one to use. */
+ /** For pages that support multiple types of ordering, which one to use.
+ */
protected $mOrderType;
/**
* $mDefaultDirection gives the direction to use when sorting results:
public $mDefaultDirection;
public $mIsBackwards;
+ /** True if the current result set is the first one */
+ public $mIsFirst;
+
/**
* Result object for the query. Warning: seek before use.
*/
# Plus an extra row so that we can tell the "next" link should be shown
$queryLimit = $this->mLimit + 1;
- $this->mResult = $this->reallyDoQuery( $this->mOffset, $queryLimit, $descending );
+ $this->mResult = $this->reallyDoQuery(
+ $this->mOffset,
+ $queryLimit,
+ $descending
+ );
$this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult );
$this->mQueryDone = true;
wfProfileOut( $fname );
}
-
+
/**
- * Return the result wrapper.
+ * @return ResultWrapper The result wrapper.
*/
function getResult() {
return $this->mResult;
}
-
+
/**
* Set the offset from an other source than $wgRequest
*/
/**
* Extract some useful data from the result object for use by
* the navigation bar, put it into $this
+ *
+ * @param $offset String: index offset, inclusive
+ * @param $limit Integer: exact query limit
+ * @param $res ResultWrapper
*/
function extractResultInfo( $offset, $limit, ResultWrapper $res ) {
$numRows = $res->numRows();
if ( $numRows ) {
+ # Remove any table prefix from index field
+ $parts = explode( '.', $this->mIndexField );
+ $indexColumn = end( $parts );
+
$row = $res->fetchRow();
- $firstIndex = $row[$this->mIndexField];
+ $firstIndex = $row[$indexColumn];
# Discard the extra result row if there is one
if ( $numRows > $this->mLimit && $numRows > 1 ) {
$this->mPastTheEndIndex = $this->mPastTheEndRow->$indexField;
$res->seek( $numRows - 2 );
$row = $res->fetchRow();
- $lastIndex = $row[$this->mIndexField];
+ $lastIndex = $row[$indexColumn];
} else {
$this->mPastTheEndRow = null;
# Setting indexes to an empty string means that they will be
$this->mPastTheEndIndex = '';
$res->seek( $numRows - 1 );
$row = $res->fetchRow();
- $lastIndex = $row[$this->mIndexField];
+ $lastIndex = $row[$indexColumn];
}
} else {
$firstIndex = '';
}
}
+ /**
+ * Get some text to go in brackets in the "function name" part of the SQL comment
+ *
+ * @return String
+ */
+ function getSqlComment() {
+ return get_class( $this );
+ }
+
/**
* Do a query with specified parameters, rather than using the object
* context
*
- * @param string $offset Index offset, inclusive
- * @param integer $limit Exact query limit
- * @param boolean $descending Query direction, false for ascending, true for descending
+ * @param $offset String: index offset, inclusive
+ * @param $limit Integer: exact query limit
+ * @param $descending Boolean: query direction, false for ascending, true for descending
* @return ResultWrapper
*/
function reallyDoQuery( $offset, $limit, $descending ) {
- $fname = __METHOD__ . ' (' . get_class( $this ) . ')';
+ $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
$info = $this->getQueryInfo();
$tables = $info['tables'];
$fields = $info['fields'];
/**
* Pre-process results; useful for performing batch existence checks, etc.
*
- * @param ResultWrapper $result Result wrapper
+ * @param $result ResultWrapper
*/
protected function preprocessResults( $result ) {}
/**
* Get the formatted result list. Calls getStartBody(), formatRow() and
* getEndBody(), concatenates the results and returns them.
+ *
+ * @return String
*/
function getBody() {
if ( !$this->mQueryDone ) {
/**
* Make a self-link
+ *
+ * @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) {
if ( $query === null ) {
if( $type ) {
$attrs['class'] = "mw-{$type}link";
}
- return $this->getSkin()->link( $this->getTitle(), $text,
- $attrs, $query + $this->getDefaultQuery(), array('noclasses','known') );
+ 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
* will be called even if there are no rows in the result set.
+ *
+ * @return String
*/
function getStartBody() {
return '';
/**
* Hook into getBody() for the end of the list
+ *
+ * @return String
*/
function getEndBody() {
return '';
/**
* Hook into getBody(), for the bit between the start and the
* end when there are no rows
+ *
+ * @return String
*/
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 ) ) {
* 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
*/
function getDefaultQuery() {
if ( !isset( $this->mDefaultQuery ) ) {
/**
* Get the number of rows in the result set
+ *
+ * @return Integer
*/
function getNumRows() {
if ( !$this->mQueryDone ) {
/**
* Get a URL query array for the prev, next, first and last links.
+ *
+ * @return Array
*/
function getPagingQueries() {
if ( !$this->mQueryDone ) {
$prev = false;
$first = false;
} else {
- $prev = array( 'dir' => 'prev', 'offset' => $this->mFirstShown, 'limit' => $urlLimit );
+ $prev = array(
+ 'dir' => 'prev',
+ 'offset' => $this->mFirstShown,
+ 'limit' => $urlLimit
+ );
$first = array( 'limit' => $urlLimit );
}
if ( $this->mIsLast ) {
$next = array( 'offset' => $this->mLastShown, 'limit' => $urlLimit );
$last = array( 'dir' => 'prev', 'limit' => $urlLimit );
}
- return array( 'prev' => $prev, 'next' => $next, 'first' => $first, 'last' => $last );
+ return array(
+ 'prev' => $prev,
+ 'next' => $next,
+ 'first' => $first,
+ 'last' => $last
+ );
+ }
+
+ /**
+ * Returns whether to show the "navigation bar"
+ *
+ * @return Boolean
+ */
+ function isNavigationBarShown() {
+ if ( !$this->mQueryDone ) {
+ $this->doQuery();
+ }
+ // Hide navigation by default if there is nothing to page
+ return !($this->mIsFirst && $this->mIsLast);
}
/**
* will be used. If there is no such item, the unlinked text from
* $linkTexts will be used. Both $linkTexts and $disabledTexts are arrays
* of HTML.
+ *
+ * @return Array
*/
function getPagingLinks( $linkTexts, $disabledTexts = array() ) {
$queries = $this->getPagingQueries();
$links = array();
foreach ( $queries as $type => $query ) {
if ( $query !== false ) {
- $links[$type] = $this->makeLink( $linkTexts[$type], $queries[$type], $type );
+ $links[$type] = $this->makeLink(
+ $linkTexts[$type],
+ $queries[$type],
+ $type
+ );
} elseif ( isset( $disabledTexts[$type] ) ) {
$links[$type] = $disabledTexts[$type];
} else {
$offset = $this->mOffset;
}
foreach ( $this->mLimitsShown as $limit ) {
- $links[] = $this->makeLink( $wgLang->formatNum( $limit ),
- array( 'offset' => $offset, 'limit' => $limit ), 'num' );
+ $links[] = $this->makeLink(
+ $wgLang->formatNum( $limit ),
+ array( 'offset' => $offset, 'limit' => $limit ),
+ 'num'
+ );
}
return $links;
}
* Abstract formatting function. This should return an HTML string
* representing the result row $row. Rows will be concatenated and
* returned by getBody()
+ *
+ * @param $row Object: database row
+ * @return String
*/
abstract function formatRow( $row );
* fields => Field(s) for passing to Database::select(), may be *
* conds => WHERE conditions
* options => option array
+ * join_conds => JOIN conditions
+ *
+ * @return Array
*/
abstract function getQueryInfo();
* $this->mDefaultDirection member variable. That's the default for this
* particular instantiation, which is a single value. This is the set of
* all defaults for the class.
+ *
+ * @return Boolean
*/
protected function getDefaultDirections() { return false; }
}
function getNavigationBar() {
global $wgLang;
+ if ( !$this->isNavigationBarShown() ) return '';
+
if( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
$opts = array( 'parsemag', 'escapenoentities' );
$linkTexts = array(
- 'prev' => wfMsgExt( 'prevn', $opts, $wgLang->formatNum( $this->mLimit ) ),
- 'next' => wfMsgExt( 'nextn', $opts, $wgLang->formatNum($this->mLimit ) ),
+ '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 )
);
$limits = $wgLang->pipeList( $limitLinks );
$this->mNavigationBar =
- "(" . $wgLang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " .
+ "(" . $wgLang->pipeList(
+ array( $pagingLinks['first'],
+ $pagingLinks['last'] )
+ ) . ") " .
wfMsgHtml( 'viewprevnext', $pagingLinks['prev'],
$pagingLinks['next'], $limits );
* enabling each one in getNavigationBar. The return type is an associa-
* tive array whose keys must exactly match the keys of the array returned
* by getIndexField(), and whose values are message keys.
- * @return array
+ *
+ * @return Array
*/
protected function getOrderTypeMessages() {
return null;
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' )
);
$limitLinks = $this->getLimitLinks();
$limits = $wgLang->pipeList( $limitLinks );
- $this->mNavigationBar = "({$pagingLinks['first']}" . wfMsgExt( 'pipe-separator' , 'escapenoentities' ) . "{$pagingLinks['last']}) " .
- wfMsgHtml("viewprevnext", $pagingLinks['prev'], $pagingLinks['next'], $limits);
+ $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);
# Make table header
foreach ( $fields as $field => $name ) {
if ( strval( $name ) == '' ) {
- $s .= "<th> </th>\n";
+ $s .= "<th> </th>\n";
} elseif ( $this->isFieldSortable( $field ) ) {
$query = array( 'sort' => $field, 'limit' => $this->mLimit );
if ( $field == $this->mSort ) {
}
function formatRow( $row ) {
- $rowClass = $this->getRowClass( $row );
- $s = "<tr class=\"$rowClass\">\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 = ' ';
+ $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;
}
- function getRowClass($row) {
+ /**
+ * Get a class name to be applied to the given row.
+ *
+ * @param $row Object: the database result row
+ * @return String
+ */
+ function getRowClass( $row ) {
return '';
}
+ /**
+ * Get attributes to be applied to the given row.
+ *
+ * @param $row Object: the database result row
+ * @return Associative array
+ */
+ function getRowAttrs( $row ) {
+ $class = $this->getRowClass( $row );
+ if ( $class === '' ) {
+ // Return an empty array to avoid clutter in HTML like class=""
+ return array();
+ } else {
+ 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',
'last' => 'table_pager_last',
);
$images = array(
- 'first' => $wgContLang->isRTL() ? 'arrow_last_25.png' : 'arrow_first_25.png',
- 'prev' => $wgContLang->isRTL() ? 'arrow_right_25.png' : 'arrow_left_25.png',
- 'next' => $wgContLang->isRTL() ? 'arrow_left_25.png' : 'arrow_right_25.png',
- 'last' => $wgContLang->isRTL() ? 'arrow_first_25.png' : 'arrow_last_25.png',
+ 'first' => 'arrow_first_25.png',
+ 'prev' => 'arrow_left_25.png',
+ 'next' => 'arrow_right_25.png',
+ 'last' => 'arrow_last_25.png',
);
$disabledImages = array(
- 'first' => $wgContLang->isRTL() ? 'arrow_disabled_last_25.png' : 'arrow_disabled_first_25.png',
- 'prev' => $wgContLang->isRTL() ? 'arrow_disabled_right_25.png' : 'arrow_disabled_left_25.png',
- 'next' => $wgContLang->isRTL() ? 'arrow_disabled_left_25.png' : 'arrow_disabled_right_25.png',
- 'last' => $wgContLang->isRTL() ? 'arrow_disabled_first_25.png' : 'arrow_disabled_last_25.png',
+ 'first' => 'arrow_disabled_first_25.png',
+ 'prev' => 'arrow_disabled_left_25.png',
+ 'next' => 'arrow_disabled_right_25.png',
+ 'last' => 'arrow_disabled_last_25.png',
);
+ if( $wgContLang->isRTL() ) {
+ $keys = array_keys( $labels );
+ $images = array_combine( $keys, array_reverse( $images ) );
+ $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) );
+ }
$linkTexts = array();
$disabledTexts = array();
foreach ( $labels as $type => $label ) {
$msgLabel = wfMsgHtml( $label );
- $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
- $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br/>$msgLabel";
+ $linkTexts[$type] = "<img src=\"$path/{$images[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
+ $disabledTexts[$type] = "<img src=\"$path/{$disabledImages[$type]}\" alt=\"$msgLabel\"/><br />$msgLabel";
}
$links = $this->getPagingLinks( $linkTexts, $disabledTexts );
/**
* Get a <select> element which has options for each of the allowed limits
+ *
+ * @return String: HTML fragment
*/
function getLimitSelect() {
global $wgLang;
- $s = "<select name=\"limit\">";
- foreach ( $this->mLimitsShown as $limit ) {
- $selected = $limit == $this->mLimit ? 'selected="selected"' : '';
- $formattedLimit = $wgLang->formatNum( $limit );
- $s .= "<option value=\"$limit\" $selected>$formattedLimit</option>\n";
+
+ # 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 ) ) {
+ $this->mLimitsShown[] = $this->mLimit;
+ sort( $this->mLimitsShown );
+ }
+ $s = Html::openElement( 'select', array( 'name' => 'limit' ) ) . "\n";
+ foreach ( $this->mLimitsShown as $key => $value ) {
+ # The pair is either $index => $limit, in which case the $value
+ # will be numeric, or $limit => $text, in which case the $value
+ # will be a string.
+ if( is_int( $value ) ){
+ $limit = $value;
+ $text = $wgLang->formatNum( $limit );
+ } else {
+ $limit = $key;
+ $text = $value;
+ }
+ $s .= Xml::option( $text, $limit, $limit == $this->mLimit ) . "\n";
}
- $s .= "</select>";
+ $s .= Html::closeElement( 'select' );
return $s;
}
* 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.
+ *
+ * @return String: HTML fragment
*/
function getHiddenFields( $blacklist = array() ) {
$blacklist = (array)$blacklist;
/**
* Get a form containing a limit selection dropdown
+ *
+ * @return String: HTML fragment
*/
function getLimitForm() {
+ global $wgScript;
+
+ return Xml::openElement(
+ 'form',
+ array(
+ 'method' => 'get',
+ 'action' => $wgScript
+ ) ) . "\n" . $this->getLimitDropdown() . "</form>\n";
+ }
+
+ /**
+ * Gets a limit selection dropdown
+ *
+ * @return string
+ */
+ function getLimitDropdown() {
# 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() ) .
+
+ return wfMsgHtml( 'table_pager_limit', $this->getLimitSelect() ) .
"\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
- $this->getHiddenFields( array('limit','title') ) .
- "</form>\n";
+ $this->getHiddenFields( array( 'limit' ) );
}
/**
* Return true if the named field should be sortable by the UI, false
* otherwise
*
- * @param string $field
+ * @param $field String
*/
abstract function isFieldSortable( $field );
/**
* 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.
*
- * @param string $name The database field name
- * @param string $value The value retrieved from the database
+ * @param $name String: the database field name
+ * @param $value String: the value retrieved from the database
*/
abstract function formatValue( $name, $value );
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff