BlockListPager Class Reference
Inheritance diagram for BlockListPager:
Collaboration diagram for BlockListPager:
Public Member Functions | |
| __construct ($page, $conds) | |
| formatValue ($name, $value) | |
| getDefaultSort () | |
| getFieldNames () | |
| getIndexField () | |
| getQueryInfo () | |
| isFieldSortable ($name) | |
| preprocessResults ($result) | |
| Do a LinkBatch query to minimise database load when generating all these links. More... | |
 Public Member Functions inherited from TablePager | |
| __construct (IContextSource $context=null) | |
| formatRow ($row) | |
| formatValue ($name, $value) | |
| Format a table cell. More... | |
| getBody () | |
| Get the formatted result list. More... | |
| getBodyOutput () | |
| Get the formatted result list. 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... | |
| getFullOutput () | |
| Get the formatted result list, with navigation bars. More... | |
| getHiddenFields ($blacklist=[]) | |
| 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=[]) | |
| 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... | |
| getModuleStyles () | |
| ResourceLoader modules that must be loaded to provide correct styling for this pager. More... | |
| 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... | |
| getStartBody () | |
| isFieldSortable ($field) | |
| Return true if the named field should be sortable by the UI, false otherwise. 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... | |
| formatRow ($row) | |
| Abstract formatting function. 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... | |
| getIndexField () | |
| This function should be overridden to return the name of the index fi- eld. More... | |
| getLimit () | |
| Get the current limit. More... | |
| getLimitLinks () | |
| getNumRows () | |
| Get the number of rows in the result set. More... | |
| getPagingLinks ($linkTexts, $disabledTexts=[]) | |
| 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 base IContextSource 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... | |
| getStats () | |
| Get the Stats object. More... | |
| getTiming () | |
| Get the Timing 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 | |
| getTableClass () | |
| Protected Member Functions inherited from TablePager | |
| getCurrentRow () | |
| getNavClass () | |
| getSortHeaderClass () | |
| getTableClass () | |
| 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: DIR_ASCENDING or DIR_DESCENDING. 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 | |
| $conds | |
| $page | |
| Protected Attributes inherited from TablePager | |
| $mCurrentRow | |
| $mSort | |
| 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: DIR_ASCENDING or DIR_DESCENDING. More... | |
| $mDefaultLimit = 50 | |
| $mDefaultQuery | |
| $mFirstShown | |
| $mIsBackwards | |
| $mIsFirst | |
| True if the current result set is the first one. More... | |
| $mIsLast | |
| $mLimit | |
| $mLimitsShown = [ 20, 50, 100, 250, 500 ] | |
| $mNavigationBar | |
| $mOffset | |
| $mPastTheEndIndex | |
| $mPastTheEndRow | |
| $mQueryDone = false | |
| $mRequest | |
| ResultWrapper | $mResult |
| Result object for the query. More... | |
| const | DIR_ASCENDING = false |
| Constants for the $mDefaultDirection field. More... | |
| const | DIR_DESCENDING = true |
Detailed Description
Definition at line 25 of file BlockListPager.php.
Constructor & Destructor Documentation
| BlockListPager::__construct | ( | $page, | |
| $conds | |||
| ) |
- Parameters
-
SpecialPage $page array $conds
Definition at line 34 of file BlockListPager.php.
References $conds, $page, IndexPager\DIR_DESCENDING, and page.
Member Function Documentation
| BlockListPager::formatValue | ( | $name, | |
| $value | |||
| ) |
Definition at line 61 of file BlockListPager.php.
References $keys, TablePager\$mCurrentRow, $name, $timestamp, $type, $value, as, Linker\formatComment(), ContextSource\getLanguage(), SpecialPage\getTitleFor(), ContextSource\getUser(), Linker\linkKnown(), list, ContextSource\msg(), Block\parseTarget(), Html\rawElement(), Linker\TOOL_LINKS_NOBLOCK, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, Linker\userLink(), and Linker\userToolLinks().
| BlockListPager::getDefaultSort | ( | ) |
Definition at line 252 of file BlockListPager.php.
| BlockListPager::getFieldNames | ( | ) |
Definition at line 41 of file BlockListPager.php.
References as, and ContextSource\msg().
| BlockListPager::getIndexField | ( | ) |
Definition at line 248 of file BlockListPager.php.
| BlockListPager::getQueryInfo | ( | ) |
Definition at line 205 of file BlockListPager.php.
References $conds, IndexPager\getDatabase(), and ContextSource\getUser().
|
protected |
Definition at line 244 of file BlockListPager.php.
| BlockListPager::isFieldSortable | ( | $name | ) |
Definition at line 256 of file BlockListPager.php.
| BlockListPager::preprocessResults | ( | $result | ) |
Do a LinkBatch query to minimise database load when generating all these links.
- Parameters
-
ResultWrapper $result
Definition at line 264 of file BlockListPager.php.
References as, NS_USER, NS_USER_TALK, and LinkBatch\setCaller().
Member Data Documentation
|
protected |
Definition at line 27 of file BlockListPager.php.
Referenced by __construct(), and getQueryInfo().
|
protected |
Definition at line 28 of file BlockListPager.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/specials/pagers/BlockListPager.php
