MediaWiki REL1_39
|
Use TablePager for prettified output. More...
Public Member Functions | |
__construct (IContextSource $context, Language $contentLanguage, LanguageFactory $languageFactory, LanguageNameUtils $languageNameUtils, LinkRenderer $linkRenderer, ILoadBalancer $loadBalancer, LocalisationCache $localisationCache, FormOptions $opts) | |
formatRow ( $row) | |
formatValue ( $field, $value) | |
getDefaultSort () | |
The database field name used as a default sort order. | |
getQueryInfo () | |
Provides all parameters needed for the main paged query. | |
getTitle () | |
reallyDoQuery ( $offset, $limit, $order) | |
This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper. | |
Public Member Functions inherited from TablePager | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
getBody () | |
Get the formatted result list. | |
getBodyOutput () | |
Get the formatted result list. | |
getFullOutput () | |
Get the formatted result list, with navigation bars. | |
getHiddenFields ( $noResubmit=[]) | |
Get \<input type="hidden"\> elements for use in a method="get" form. | |
getIndexField () | |
Returns the name of the index field.If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=querykey will use indexfield to sort. In this case, the first returned key is the default.Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).Examples:
| |
getLimitForm () | |
Get a form containing a limit selection dropdown. | |
getLimitSelect ( $attribs=[]) | |
Get a "<select>" element which has options for each of the allowed limits. | |
getLimitSelectList () | |
Get a list of items to show in a "<select>" element of limits. | |
getModuleStyles () | |
ResourceLoader modules that must be loaded to provide correct styling for this pager.
| |
getNavigationBar () | |
A navigation bar with images. | |
Public Member Functions inherited from IndexPager | |
doQuery () | |
Do the query, using information from the object context. | |
getDatabase () | |
Get the Database object in use. | |
getDefaultQuery () | |
Get an array of query parameters that should be put into self-links. | |
getLimit () | |
Get the current limit. | |
getNavigationBuilder () | |
getNumRows () | |
Get the number of rows in the result set. | |
getOffsetQuery () | |
Get the current offset for the URL query parameter. | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. | |
getResult () | |
getResultOffset () | |
setIncludeOffset ( $include) | |
Set whether a row matching exactly the offset should be also included in the result or not. | |
setLimit ( $limit) | |
Set the limit from an other source than the request. | |
setOffset ( $offset) | |
Set the offset from an other source than the request. | |
Public Member Functions inherited from ContextSource | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. | |
getActionName () | |
Get the action name for the current web request. | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
setContext (IContextSource $context) | |
Static Public Member Functions | |
static | getCustomisedStatuses ( $messageNames, $langcode='en', $foreign=false, IDatabase $dbr=null) |
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist. | |
Public Attributes | |
null bool | $custom |
Language | $lang |
Public Attributes inherited from IndexPager | |
IDatabase | $mDb |
bool | $mDefaultDirection |
$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. | |
int | $mDefaultLimit = 50 |
The default entry limit choosen for clients. | |
bool | $mIsBackwards |
bool | $mIsFirst |
True if the current result set is the first one. | |
bool | $mIsLast |
int | $mLimit |
The maximum number of entries to show. | |
int[] | $mLimitsShown = [ 20, 50, 100, 250, 500 ] |
List of default entry limit options to be presented to clients. | |
mixed | $mOffset |
The starting point to enumerate entries. | |
stdClass bool null | $mPastTheEndRow |
Extra row fetched at the end to see if the end was reached. | |
bool | $mQueryDone = false |
Whether the listing query completed. | |
WebRequest | $mRequest |
IResultWrapper | $mResult |
Result object for the query. | |
const | DIR_ASCENDING = false |
Backwards-compatible constant for $mDefaultDirection field (do not change) | |
const | DIR_DESCENDING = true |
Backwards-compatible constant for $mDefaultDirection field (do not change) | |
const | QUERY_ASCENDING = true |
Backwards-compatible constant for reallyDoQuery() (do not change) | |
const | QUERY_DESCENDING = false |
Backwards-compatible constant for reallyDoQuery() (do not change) | |
Protected Member Functions | |
getCellAttrs ( $field, $value) | |
getEndBody () | |
getFieldNames () | |
An array mapping database field names to a textual description of the field name, for use in the table header. | |
getRowAttrs ( $row) | |
Get attributes to be applied to the given row. | |
getStartBody () | |
isFieldSortable ( $x) | |
Return true if the named field should be sortable by the UI, false otherwise. | |
Protected Member Functions inherited from TablePager | |
getCurrentRow () | |
getEmptyBody () | |
getNavClass () | |
getRowClass ( $row) | |
Get a class name to be applied to the given row. | |
getSortHeaderClass () | |
getTableClass () | |
TablePager relies on mw-datatable for styling, see T214208. | |
Protected Member Functions inherited from IndexPager | |
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. | |
buildQueryInfo ( $offset, $limit, $order) | |
Build variables to use by the database wrapper. | |
doBatchLookups () | |
Called from getBody(), before getStartBody() is called and after doQuery() was called. | |
extractResultInfo ( $isFirst, $limit, IResultWrapper $res) | |
Extract some useful data from the result object for use by the navigation bar, put it into $this. | |
getDefaultDirections () | |
Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. | |
getExtraSortFields () | |
Returns the names of secondary columns to order by in addition to the column in getIndexField(). | |
getFooter () | |
Classes can extend to output a footer at the bottom of the pager list. | |
getLimitLinks () | |
getLinkRenderer () | |
getPagingLinks ( $linkTexts, $disabledTexts=[]) | |
Get paging links. | |
getRow ( $row) | |
Get the HTML of a pager row. | |
getSqlComment () | |
Get some text to go in brackets in the "function name" part of the SQL comment. | |
isNavigationBarShown () | |
Returns whether to show the "navigation bar". | |
makeLink ( $text, array $query=null, $type=null) | |
Make a self-link. | |
preprocessResults ( $result) | |
Pre-process results; useful for performing batch existence checks, etc. | |
Protected Attributes | |
bool | $foreign |
string | $langcode |
string false | $prefix |
string | $suffix |
Protected Attributes inherited from TablePager | |
stdClass | $mCurrentRow |
string | $mSort |
Protected Attributes inherited from IndexPager | |
array | $mDefaultQuery |
string[] | $mExtraSortFields |
An array of secondary columns to order by. | |
array | $mFirstShown |
bool | $mIncludeOffset = false |
Whether to include the offset in the query. | |
string string[] | $mIndexField |
The index to actually be used for ordering. | |
array | $mLastShown |
string | $mNavigationBar |
string null | $mOrderType |
For pages that support multiple types of ordering, which one to use. | |
array | $mPastTheEndIndex |
Additional Inherited Members | |
Static Protected Member Functions inherited from IndexPager | |
static | oppositeOrder ( $order) |
Use TablePager for prettified output.
We have to pretend that we're getting data from a table when in fact not all of it comes from the database.
Definition at line 36 of file AllMessagesTablePager.php.
AllMessagesTablePager::__construct | ( | IContextSource | $context, |
Language | $contentLanguage, | ||
LanguageFactory | $languageFactory, | ||
LanguageNameUtils | $languageNameUtils, | ||
LinkRenderer | $linkRenderer, | ||
ILoadBalancer | $loadBalancer, | ||
LocalisationCache | $localisationCache, | ||
FormOptions | $opts ) |
IContextSource | $context | |
Language | $contentLanguage | |
LanguageFactory | $languageFactory | |
LanguageNameUtils | $languageNameUtils | |
LinkRenderer | $linkRenderer | |
ILoadBalancer | $loadBalancer | |
LocalisationCache | $localisationCache | |
FormOptions | $opts |
Definition at line 81 of file AllMessagesTablePager.php.
References $lang, $langcode, $prefix, IndexPager\DIR_DESCENDING, Language\getCode(), Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), ContextSource\getLanguage(), MediaWiki\Languages\LanguageFactory\getRawLanguage(), FormOptions\getValue(), MediaWiki\Languages\LanguageNameUtils\isKnownLanguageTag(), and NS_MEDIAWIKI.
AllMessagesTablePager::formatRow | ( | $row | ) |
stdClass | $row |
Reimplemented from TablePager.
Definition at line 338 of file AllMessagesTablePager.php.
References $s, formatValue(), getCellAttrs(), and getRowAttrs().
AllMessagesTablePager::formatValue | ( | $field, | |
$value ) |
string | $field | |
string | null | $value |
Reimplemented from TablePager.
Definition at line 287 of file AllMessagesTablePager.php.
References $title, ContextSource\getLanguage(), IndexPager\getLinkRenderer(), Linker\makeExternalLink(), ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfArrayToCgi().
Referenced by formatRow().
|
protected |
string | $field | |
string | $value |
Reimplemented from TablePager.
Definition at line 367 of file AllMessagesTablePager.php.
Referenced by formatRow().
|
static |
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Returns [ 'pages' => ..., 'talks' => ... ], where the subarrays have an entry for each existing page, with the key being the message name and value arbitrary.
array | $messageNames | |
string | $langcode | What language code |
bool | $foreign | Whether the $langcode is not the content language |
IDatabase | null | $dbr |
Definition at line 165 of file AllMessagesTablePager.php.
References $dbr, $foreign, $langcode, $res, $s, $title, DB_REPLICA, NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfGetDB().
Referenced by ApiQueryAllMessages\execute(), DeleteEqualMessages\fetchMessageInfo(), and reallyDoQuery().
AllMessagesTablePager::getDefaultSort | ( | ) |
The database field name used as a default sort order.
Note that this field will only be sorted on if isFieldSortable returns true for this field. If not (e.g. paginating on multiple columns), this should return empty string, and getIndexField should be overridden.
Reimplemented from TablePager.
Definition at line 402 of file AllMessagesTablePager.php.
|
protected |
Reimplemented from TablePager.
Definition at line 278 of file AllMessagesTablePager.php.
|
protected |
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 from TablePager.
Definition at line 387 of file AllMessagesTablePager.php.
References ContextSource\msg().
AllMessagesTablePager::getQueryInfo | ( | ) |
Provides 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
Reimplemented from IndexPager.
Definition at line 406 of file AllMessagesTablePager.php.
|
protected |
Get attributes to be applied to the given row.
stdClass | $row | The database result row |
Reimplemented from TablePager.
Definition at line 358 of file AllMessagesTablePager.php.
Referenced by formatRow().
|
protected |
Reimplemented from TablePager.
Definition at line 257 of file AllMessagesTablePager.php.
References TablePager\getTableClass(), and ContextSource\msg().
AllMessagesTablePager::getTitle | ( | ) |
Reimplemented from ContextSource.
Definition at line 394 of file AllMessagesTablePager.php.
References SpecialPage\getTitleFor().
|
protected |
Return true if the named field should be sortable by the UI, false otherwise.
string | $field |
Reimplemented from TablePager.
Definition at line 398 of file AllMessagesTablePager.php.
AllMessagesTablePager::reallyDoQuery | ( | $offset, | |
$limit, | |||
$order ) |
This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.
string | $offset | |
int | $limit | |
bool | $order |
Reimplemented from IndexPager.
Definition at line 218 of file AllMessagesTablePager.php.
References getCustomisedStatuses(), IndexPager\getDatabase(), ContextSource\msg(), and IndexPager\QUERY_ASCENDING.
null bool AllMessagesTablePager::$custom |
Definition at line 66 of file AllMessagesTablePager.php.
|
protected |
Definition at line 46 of file AllMessagesTablePager.php.
Referenced by getCustomisedStatuses().
Language AllMessagesTablePager::$lang |
Definition at line 61 of file AllMessagesTablePager.php.
Referenced by __construct().
|
protected |
Definition at line 41 of file AllMessagesTablePager.php.
Referenced by __construct(), and getCustomisedStatuses().
|
protected |
Definition at line 51 of file AllMessagesTablePager.php.
Referenced by __construct().
|
protected |
Definition at line 56 of file AllMessagesTablePager.php.