MediaWiki\Pager\AlphabeticPager Class Reference
IndexPager with an alphabetic list and a formatted navigation bar. More...
Inherits MediaWiki\Pager\IndexPager.
Inherited by MediaWiki\Specials\Pager\CategoryPager, MediaWiki\Specials\Pager\ProtectedTitlesPager, and MediaWiki\Specials\Pager\UsersPager.
Collaboration diagram for MediaWiki\Pager\AlphabeticPager:
Public Member Functions | |
| getNavigationBar () | |
 Public Member Functions inherited from MediaWiki\Pager\IndexPager | |
| __construct (?IContextSource $context=null, ?LinkRenderer $linkRenderer=null) | |
| doQuery () | |
| Do the query, using information from the object context. | |
| formatRow ( $row) | |
| Returns an HTML string representing the result row $row. | |
| getBody () | |
| Get the formatted result list. | |
| getDatabase () | |
| Get the Database object in use. | |
| getDefaultQuery () | |
| Get an array of query parameters that should be put into self-links. | |
| getIndexField () | |
| Returns the name of the index field. | |
| getLimit () | |
| Get the current limit. | |
| getModuleStyles () | |
| ResourceLoader modules that must be loaded to provide correct styling for this pager. | |
| getNavigationBuilder () | |
| Get a configured navigation builder for this pager. | |
| getNumRows () | |
| Get the number of rows in the result set. | |
| getOffset () | |
| getOffsetQuery () | |
| Get the current offset for the URL query parameter. | |
| getPagingQueries () | |
| Get a URL query array for the prev, next, first and last links. | |
| getQueryInfo () | |
| Provides all parameters needed for the main paged query. | |
| getQueryOrder () | |
| getResult () | |
| getResultOffset () | |
| 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 MediaWiki\Context\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 () | |
| getLanguageCode () | |
| getOutput () | |
| getRequest () | |
| getSkin () | |
| 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 MediaWiki\Pager\IndexPager | |
| IReadableDatabase | $mDb |
| bool null | $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 MediaWiki\Pager\IndexPager | |
| buildQueryInfo ( $offset, $limit, $order) | |
| Build variables to use by the database wrapper. | |
| createNavigationBuilder () | |
| Create a new navigation builder instance. | |
| 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. | |
| 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 () | |
| 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. | |
| getLinkRenderer () | |
| getOffsetCondsAndSortOptions ( $offset, int $limit, bool $order) | |
| Get $conds and $options relevant for sorting. | |
| 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. | |
| getStartBody () | |
| Hook into getBody(), allows text to be inserted at the start. | |
| 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. | |
| Static Protected Member Functions inherited from MediaWiki\Pager\IndexPager | |
| static | oppositeOrder ( $order) |
| Protected Attributes inherited from MediaWiki\Pager\IndexPager | |
| array null | $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 null | $mNavigationBar |
| string null | $mOrderType |
| For pages that support multiple types of ordering, which one to use. | |
| array | $mPastTheEndIndex |
| PagerNavigationBuilder | $navigationBuilder = null |
Detailed Description
IndexPager with an alphabetic list and a formatted navigation bar.
- Stability: stable
- to extend
Definition at line 15 of file AlphabeticPager.php.
Member Function Documentation
◆ getNavigationBar()
| MediaWiki\Pager\AlphabeticPager::getNavigationBar | ( | ) |
- Stability: stable
- to override
- Returns
- string HTML
Implements MediaWiki\Pager\Pager.
Definition at line 21 of file AlphabeticPager.php.
References MediaWiki\Pager\IndexPager\$mNavigationBar, MediaWiki\Pager\IndexPager\getNavigationBuilder(), and MediaWiki\Pager\IndexPager\isNavigationBarShown().
The documentation for this class was generated from the following file:
- includes/Pager/AlphabeticPager.php
