Public Member Functions | |
| __construct (IContextSource $context, $from, LinkRenderer $linkRenderer) | |
| formatRow ( $result) | |
| Abstract formatting function. | |
| getBody () | |
| Get the formatted result list. | |
| getDefaultQuery () | |
| Get an array of query parameters that should be put into self-links. | |
| getIndexField () | |
| This function should be overridden to return the name of the index fi- eld. | |
| getQueryInfo () | |
| This function should be overridden to provide all parameters needed for the main paged query. | |
| 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. | |
| Public Member Functions inherited from IndexPager | |
| __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
| doQuery () | |
| Do the query, using information from the object context. | |
| extractResultInfo ( $isFirst, $limit, IResultWrapper $res) | |
| Extract some useful data from the result object for use by the navigation bar, put it into $this. | |
| getDatabase () | |
| Get the Database object in use. | |
| getLimit () | |
| Get the current limit. | |
| getLimitLinks () | |
| getNumRows () | |
| Get the number of rows in the result set. | |
| getPagingLinks ( $linkTexts, $disabledTexts=[]) | |
| Get paging links. | |
| getPagingQueries () | |
| Get a URL query array for the prev, next, first and last links. | |
| getResult () | |
| 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. | |
| reallyDoQuery ( $offset, $limit, $order) | |
| Do a query with specified parameters, rather than using the object context. | |
| 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. | |
| getConfig () | |
| getContext () | |
| Get the base IContextSource object. | |
| getLanguage () | |
| getOutput () | |
| getRequest () | |
| getSkin () | |
| getStats () | |
| getTiming () | |
| getTitle () | |
| 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) | |
Additional Inherited Members | |
| 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 inherited from AlphabeticPager | |
| getOrderTypeMessages () | |
| If this supports multiple order type messages, give the message key for enabling each one in getNavigationBar. | |
| 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. | |
| getDefaultDirections () | |
| Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. | |
| getEmptyBody () | |
| Hook into getBody(), for the bit between the start and the end when there are no rows. | |
| getEndBody () | |
| Hook into getBody() for the end of the list. | |
| getExtraSortFields () | |
| This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). | |
| getLinkRenderer () | |
| getStartBody () | |
| Hook into getBody(), allows text to be inserted at the start. | |
| preprocessResults ( $result) | |
| Pre-process results; useful for performing batch existence checks, etc. | |
| Static Protected Member Functions inherited from IndexPager | |
| static | oppositeOrder ( $order) |
| Protected Attributes inherited from IndexPager | |
| array | $mDefaultQuery |
| string[] | $mExtraSortFields |
| An array of secondary columns to order by. | |
| mixed | $mFirstShown |
| bool | $mIncludeOffset = false |
| Whether to include the offset in the query. | |
| string | $mIndexField |
| The index to actually be used for ordering. | |
| mixed | $mLastShown |
| string | $mNavigationBar |
| string null | $mOrderType |
| For pages that support multiple types of ordering, which one to use. | |
| mixed | $mPastTheEndIndex |
Detailed Description
Definition at line 26 of file CategoryPager.php.
Constructor & Destructor Documentation
◆ __construct()
| CategoryPager::__construct | ( | IContextSource | $context, |
| $from, | |||
| LinkRenderer | $linkRenderer ) |
- Parameters
-
IContextSource $context string $from LinkRenderer $linkRenderer
Definition at line 33 of file CategoryPager.php.
References ContextSource\$context, IndexPager\$linkRenderer, 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 78 of file CategoryPager.php.
References $title, ContextSource\getLanguage(), IndexPager\getLinkRenderer(), ContextSource\msg(), and NS_CATEGORY.
◆ 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 64 of file CategoryPager.php.
References LinkBatch\addObj(), and NS_CATEGORY.
◆ 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 56 of file CategoryPager.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|string[]
Reimplemented from IndexPager.
Definition at line 52 of file CategoryPager.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 44 of file CategoryPager.php.
◆ getStartForm()
| CategoryPager::getStartForm | ( | $from | ) |
Definition at line 87 of file CategoryPager.php.
References ContextSource\getContext(), and NS_CATEGORY.
The documentation for this class was generated from the following file:
- includes/specials/pagers/CategoryPager.php
