TODO: Allow sorting by count. More...
Public Member Functions | |
| __construct (IContextSource $context, $from, PageLinkRenderer $linkRenderer) | |
| formatRow ( $result) | |
| Abstract formatting function. More... | |
| getBody () | |
| Get the formatted result list. More... | |
| getDefaultQuery () | |
| Get an array of query parameters that should be put into self-links. More... | |
| getIndexField () | |
| This function should be overridden to return the name of the index fi- eld. More... | |
| getQueryInfo () | |
| This function should be overridden to provide all parameters needed for the main paged query. More... | |
| getStartForm ( $from) | |
 Public Member Functions inherited from AlphabeticPager | |
| getNavigationBar () | |
| Shamelessly stolen bits from ReverseChronologicalPager, didn't want to do class magic as may be still revamped. More... | |
| Public Member Functions inherited from IndexPager | |
| __construct (IContextSource $context=null) | |
| 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... | |
| getDatabase () | |
| Get the Database object in use. 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... | |
| 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... | |
Protected Member Functions | |
| getDefaultDirections () | |
| Return the default sorting direction: false for ascending, true for descending. More... | |
| Protected Member Functions inherited from AlphabeticPager | |
| getOrderTypeMessages () | |
| If this supports multiple order type messages, give the message key for enabling each one in getNavigationBar. More... | |
| 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... | |
| getEmptyBody () | |
| Hook into getBody(), for the bit between the start and the end when there are no rows. More... | |
| getEndBody () | |
| Hook into getBody() for the end of the list. 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... | |
| getStartBody () | |
| Hook into getBody(), allows text to be inserted at the start. More... | |
| preprocessResults ( $result) | |
| Pre-process results; useful for performing batch existence checks, etc. More... | |
Protected Attributes | |
| PageLinkRenderer | $linkRenderer |
| 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... | |
Additional Inherited Members | |
| 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... | |
Detailed Description
TODO: Allow sorting by count.
We need to have a unique index to do this properly.
Definition at line 101 of file SpecialCategories.php.
Constructor & Destructor Documentation
◆ __construct()
| CategoryPager::__construct | ( | IContextSource | $context, |
| $from, | |||
| PageLinkRenderer | $linkRenderer | ||
| ) |
- Parameters
-
IContextSource $context string $from PageLinkRenderer $linkRenderer
Definition at line 112 of file SpecialCategories.php.
References ContextSource\$context, $from, $linkRenderer, Title\capitalize(), NS_CATEGORY, IndexPager\setIncludeOffset(), and IndexPager\setOffset().
Member Function Documentation
◆ formatRow()
| CategoryPager::formatRow | ( | $row | ) |
Abstract formatting function.
This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()
- Parameters
-
array | stdClass $row Database row
- Returns
- string
Reimplemented from IndexPager.
Definition at line 171 of file SpecialCategories.php.
References $count, $link, $title, ContextSource\getLanguage(), ContextSource\msg(), NS_CATEGORY, and Html\rawElement().
◆ getBody()
| CategoryPager::getBody | ( | ) |
Get the formatted result list.
Calls getStartBody(), formatRow() and getEndBody(), concatenates the results and returns them.
- Returns
- String
Reimplemented from IndexPager.
Definition at line 157 of file SpecialCategories.php.
References $batch, as, Title\makeTitleSafe(), and NS_CATEGORY.
◆ getDefaultDirections()
|
protected |
Return the default sorting direction: false for ascending, true for descending.
You can also have an associative array of ordertype => dir, if multiple order types are supported. In this case getIndexField() must return an array, and the keys of that must exactly match the keys of this.
For backward compatibility, this method's return value will be ignored if $this->mDefaultDirection is already set when the constructor is called, for instance if it's statically initialized. In that case the value of that variable (which must be a boolean) will be used.
Note that despite its name, this does not return the value of the $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.
- Returns
- Boolean
Reimplemented from IndexPager.
Definition at line 151 of file SpecialCategories.php.
◆ getDefaultQuery()
| CategoryPager::getDefaultQuery | ( | ) |
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.
- Returns
- array Associative array
Reimplemented from IndexPager.
Definition at line 139 of file SpecialCategories.php.
References IndexPager\$mDefaultQuery.
◆ getIndexField()
| CategoryPager::getIndexField | ( | ) |
This function should be overridden to return the name of the index fi- eld.
If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=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.
- Returns
- string|Array
Reimplemented from IndexPager.
Definition at line 134 of file SpecialCategories.php.
◆ getQueryInfo()
| CategoryPager::getQueryInfo | ( | ) |
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
- Returns
- Array
Reimplemented from IndexPager.
Definition at line 125 of file SpecialCategories.php.
References array().
◆ getStartForm()
| CategoryPager::getStartForm | ( | $from | ) |
Definition at line 180 of file SpecialCategories.php.
References $from, array(), Xml\fieldset(), ContextSource\getTitle(), global, Html\hidden(), Xml\inputLabel(), ContextSource\msg(), Xml\submitButton(), Xml\tags(), and text.
Member Data Documentation
◆ $linkRenderer
|
protected |
Definition at line 105 of file SpecialCategories.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/specials/SpecialCategories.php
