MediaWiki
1.23.7
|
Table-based display with a user-selectable sort order. More...
Public Member Functions | |
__construct (IContextSource $context=null) | |
formatRow ( $row) | |
formatValue ( $name, $value) | |
Format a table cell. More... | |
getCellAttrs ( $field, $value) | |
Get any extra attributes to be applied to the given cell. More... | |
getDefaultSort () | |
The database field name used as a default sort order. More... | |
getEmptyBody () | |
getEndBody () | |
getFieldNames () | |
An array mapping database field names to a textual description of the field name, for use in the table header. More... | |
getHiddenFields ( $blacklist=array()) | |
Get <input type="hidden"> elements for use in a method="get" form. More... | |
getIndexField () | |
getLimitDropdown () | |
Gets a limit selection dropdown. More... | |
getLimitForm () | |
Get a form containing a limit selection dropdown. More... | |
getLimitSelect ( $attribs=array()) | |
Get a "<select>" element which has options for each of the allowed limits. More... | |
getLimitSelectList () | |
Get a list of items to show in a "<select>" element of limits. More... | |
getNavClass () | |
getNavigationBar () | |
A navigation bar with images. More... | |
getRowAttrs ( $row) | |
Get attributes to be applied to the given row. More... | |
getRowClass ( $row) | |
Get a class name to be applied to the given row. More... | |
getSortHeaderClass () | |
getStartBody () | |
getTableClass () | |
isFieldSortable ( $field) | |
Return true if the named field should be sortable by the UI, false otherwise. More... | |
Public Member Functions inherited from IndexPager | |
doQuery () | |
Do the query, using information from the object context. More... | |
extractResultInfo ( $isFirst, $limit, ResultWrapper $res) | |
Extract some useful data from the result object for use by the navigation bar, put it into $this. More... | |
getBody () | |
Get the formatted result list. More... | |
getDatabase () | |
Get the Database object in use. More... | |
getDefaultQuery () | |
Get an array of query parameters that should be put into self-links. More... | |
getLimit () | |
Get the current limit. More... | |
getLimitLinks () | |
getNumRows () | |
Get the number of rows in the result set. More... | |
getPagingLinks ( $linkTexts, $disabledTexts=array()) | |
Get paging links. More... | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. More... | |
getQueryInfo () | |
This function should be overridden to provide all parameters needed for the main paged query. More... | |
getResult () | |
getSqlComment () | |
Get some text to go in brackets in the "function name" part of the SQL comment. More... | |
isNavigationBarShown () | |
Returns whether to show the "navigation bar". More... | |
makeLink ( $text, array $query=null, $type=null) | |
Make a self-link. More... | |
reallyDoQuery ( $offset, $limit, $descending) | |
Do a query with specified parameters, rather than using the object context. More... | |
setIncludeOffset ( $include) | |
Set whether a row matching exactly the offset should be also included in the result or not. More... | |
setLimit ( $limit) | |
Set the limit from an other source than the request. More... | |
setOffset ( $offset) | |
Set the offset from an other source than the request. More... | |
Public Member Functions inherited from ContextSource | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). More... | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. More... | |
getConfig () | |
Get the Config object. More... | |
getContext () | |
Get the RequestContext object. More... | |
getLang () | |
Get the Language object. More... | |
getLanguage () | |
Get the Language object. More... | |
getOutput () | |
Get the OutputPage object. More... | |
getRequest () | |
Get the WebRequest object. More... | |
getSkin () | |
Get the Skin object. More... | |
getTitle () | |
Get the Title object. More... | |
getUser () | |
Get the User object. More... | |
getWikiPage () | |
Get the WikiPage object. More... | |
msg () | |
Get a Message object with context set Parameters are the same as wfMessage() More... | |
setContext (IContextSource $context) | |
Set the IContextSource object. More... | |
Public Attributes | |
$mCurrentRow | |
$mSort | |
Public Attributes inherited from IndexPager | |
$mDb | |
$mDefaultDirection | |
$mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More... | |
$mDefaultLimit = 50 | |
$mDefaultQuery | |
$mFirstShown | |
$mIsBackwards | |
$mIsFirst | |
True if the current result set is the first one. More... | |
$mIsLast | |
$mLimit | |
$mLimitsShown = array( 20, 50, 100, 250, 500 ) | |
$mNavigationBar | |
$mOffset | |
$mPastTheEndIndex | |
$mPastTheEndRow | |
$mQueryDone = false | |
$mRequest | |
ResultWrapper | $mResult |
Result object for the query. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from IndexPager | |
buildQueryInfo ( $offset, $limit, $descending) | |
Build variables to use by the database wrapper. More... | |
doBatchLookups () | |
Called from getBody(), before getStartBody() is called and after doQuery() was called. More... | |
getDefaultDirections () | |
Return the default sorting direction: false for ascending, true for descending. More... | |
getExtraSortFields () | |
This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More... | |
preprocessResults ( $result) | |
Pre-process results; useful for performing batch existence checks, etc. More... | |
Protected Attributes inherited from IndexPager | |
$mExtraSortFields | |
An array of secondary columns to order by. More... | |
$mIncludeOffset = false | |
Whether to include the offset in the query. More... | |
$mIndexField | |
The index to actually be used for ordering. More... | |
$mLastShown | |
$mOrderType | |
For pages that support multiple types of ordering, which one to use. More... | |
TablePager::__construct | ( | IContextSource | $context = null | ) |
Reimplemented from IndexPager.
Definition at line 929 of file Pager.php.
References ContextSource\$context, getDefaultSort(), getFieldNames(), ContextSource\getRequest(), isFieldSortable(), and ContextSource\setContext().
TablePager::formatRow | ( | $row | ) |
stdClass | $row |
Reimplemented from IndexPager.
Reimplemented in AllmessagesTablePager.
Definition at line 1028 of file Pager.php.
References $name, $s, $value, as, Html\closeElement(), formatValue(), getCellAttrs(), getFieldNames(), getRowAttrs(), Html\openElement(), and Html\rawElement().
|
abstract |
Format a table cell.
The return value should be HTML, but use an empty string not   for empty cells. Do not include the
and .
The current result row is available as $this->mCurrentRow, in case you need more context.
string | $name | the database field name |
string | $value | the value retrieved from the database |
Reimplemented in BlockListPager, ImageListPager, ProtectedPagesPager, and AllmessagesTablePager.
Referenced by formatRow().
TablePager::getCellAttrs | ( | $field, | |
$value | |||
) |
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
string | $field | The column |
string | $value | The cell contents |
Reimplemented in AllmessagesTablePager.
Definition at line 1090 of file Pager.php.
References array().
Referenced by formatRow().
|
abstract |
The database field name used as a default sort order.
Reimplemented in ProtectedPagesPager, AllmessagesTablePager, BlockListPager, and ImageListPager.
Referenced by __construct().
TablePager::getEmptyBody | ( | ) |
Reimplemented from IndexPager.
Definition at line 1016 of file Pager.php.
References array(), Html\element(), getFieldNames(), ContextSource\msg(), and Html\rawElement().
TablePager::getEndBody | ( | ) |
|
abstract |
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.
Reimplemented in AllmessagesTablePager, ProtectedPagesPager, BlockListPager, and ImageListPager.
Referenced by __construct(), formatRow(), getEmptyBody(), and getStartBody().
TablePager::getHiddenFields | ( | $blacklist = array() | ) |
Get <input type="hidden"> elements for use in a method="get" form.
Resubmits all defined elements of the query string, except for a blacklist, passed in the $blacklist parameter.
array | $blacklist | parameters from the request query which should not be resubmitted |
Definition at line 1237 of file Pager.php.
References $name, $query, $s, $value, array(), as, ContextSource\getRequest(), and Html\hidden().
Referenced by AllmessagesTablePager\buildForm(), and getLimitDropdown().
TablePager::getIndexField | ( | ) |
Reimplemented from IndexPager.
Reimplemented in ProtectedPagesPager, and BlockListPager.
Definition at line 1098 of file Pager.php.
References $mSort.
TablePager::getLimitDropdown | ( | ) |
Gets a limit selection dropdown.
Definition at line 1273 of file Pager.php.
References array(), getHiddenFields(), getLimitSelect(), and ContextSource\msg().
Referenced by getLimitForm().
TablePager::getLimitForm | ( | ) |
Get a form containing a limit selection dropdown.
Definition at line 1255 of file Pager.php.
References array(), getLimitDropdown(), global, and Html\rawElement().
TablePager::getLimitSelect | ( | $attribs = array() | ) |
Get a "<select>" element which has options for each of the allowed limits.
$attribs | String: Extra attributes to set |
Definition at line 1189 of file Pager.php.
References $attribs, $name, $value, as, and getLimitSelectList().
Referenced by AllmessagesTablePager\buildForm(), and getLimitDropdown().
TablePager::getLimitSelectList | ( | ) |
Get a list of items to show in a "<select>" element of limits.
This can be passed directly to XmlSelect::addOptions().
Definition at line 1205 of file Pager.php.
References $limit, IndexPager\$mLimit, $ret, $value, array(), as, and ContextSource\getLanguage().
Referenced by getLimitSelect().
TablePager::getNavClass | ( | ) |
Reimplemented in ImageListPager.
Definition at line 1114 of file Pager.php.
Referenced by getNavigationBar().
TablePager::getNavigationBar | ( | ) |
A navigation bar with images.
Implements Pager.
Definition at line 1130 of file Pager.php.
References $keys, $path, $s, $type, array(), as, Html\closeElement(), Html\element(), ContextSource\getLanguage(), getNavClass(), IndexPager\getPagingLinks(), global, IndexPager\isNavigationBarShown(), ContextSource\msg(), Html\openElement(), and Html\rawElement().
TablePager::getRowAttrs | ( | $row | ) |
Get attributes to be applied to the given row.
$row | Object: the database result row |
Definition at line 1069 of file Pager.php.
References array(), and getRowClass().
Referenced by formatRow().
TablePager::getRowClass | ( | $row | ) |
Get a class name to be applied to the given row.
$row | Object: the database result row |
Definition at line 1057 of file Pager.php.
Referenced by getRowAttrs().
TablePager::getSortHeaderClass | ( | ) |
Reimplemented in ImageListPager.
Definition at line 1122 of file Pager.php.
Referenced by getStartBody().
TablePager::getStartBody | ( | ) |
Reimplemented from IndexPager.
Reimplemented in AllmessagesTablePager.
Definition at line 953 of file Pager.php.
References $link, $name, $query, $ret, $s, array(), as, Html\element(), getFieldNames(), getSortHeaderClass(), getTableClass(), global, isFieldSortable(), IndexPager\makeLink(), ContextSource\msg(), Html\openElement(), and Html\rawElement().
TablePager::getTableClass | ( | ) |
Reimplemented in ProtectedPagesPager, ImageListPager, and BlockListPager.
Definition at line 1106 of file Pager.php.
Referenced by getStartBody().
|
abstract |
Return true if the named field should be sortable by the UI, false otherwise.
$field | String |
Reimplemented in AllmessagesTablePager, BlockListPager, ProtectedPagesPager, and ImageListPager.
Referenced by __construct(), and getStartBody().
TablePager::$mCurrentRow |
Definition at line 927 of file Pager.php.
Referenced by BlockListPager\formatValue(), and ProtectedPagesPager\formatValue().
TablePager::$mSort |
Definition at line 926 of file Pager.php.
Referenced by getIndexField().