MediaWiki  master
BlockListPager Class Reference
Inheritance diagram for BlockListPager:
Collaboration diagram for BlockListPager:

Public Member Functions

 __construct ( $page, $conds)
 
 formatValue ( $name, $value)
 
 getDefaultSort ()
 
 getFieldNames ()
 
 getIndexField ()
 
 getQueryInfo ()
 
 getTotalAutoblocks ()
 Get total number of autoblocks at any given time. More...
 
 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 ()
 
 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...
 
 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, IResultWrapper $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, $order)
 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Protected Member Functions

 getTableClass ()
 
- Protected Member Functions inherited from TablePager
 getCurrentRow ()
 
 getEndBody ()
 
 getNavClass ()
 
 getSortHeaderClass ()
 
 getStartBody ()
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. More...
 
- Protected Member Functions inherited from IndexPager
 buildPrevNextNavigation (LinkTarget $title, $offset, $limit, array $query=[], $atend=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 buildQueryInfo ( $offset, $limit, $order)
 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
 
Restriction [] $restrictions = []
 Array of restrictions. More...
 
- 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. More...
 
mixed $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string $mIndexField
 The index to actually be used for ordering. More...
 
mixed $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
mixed $mPastTheEndIndex
 

Private Member Functions

 getRestrictionListHTML (stdClass $row)
 Get Restriction List HTML. More...
 

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. More...
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients. More...
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one. More...
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show. More...
 
int [] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients. More...
 
mixed $mOffset
 The starting point to enumerate entries. More...
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached. More...
 
bool $mQueryDone = false
 Whether the listing query completed. More...
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Definition at line 32 of file BlockListPager.php.

Constructor & Destructor Documentation

◆ __construct()

BlockListPager::__construct (   $page,
  $conds 
)
Parameters
SpecialPage$page
array$conds

Definition at line 47 of file BlockListPager.php.

References $conds, and IndexPager\DIR_DESCENDING.

Member Function Documentation

◆ formatValue()

◆ getDefaultSort()

BlockListPager::getDefaultSort ( )

Definition at line 388 of file BlockListPager.php.

◆ getFieldNames()

BlockListPager::getFieldNames ( )

Definition at line 53 of file BlockListPager.php.

References as, ContextSource\msg(), and null.

◆ getIndexField()

BlockListPager::getIndexField ( )

Definition at line 384 of file BlockListPager.php.

◆ getQueryInfo()

BlockListPager::getQueryInfo ( )

◆ getRestrictionListHTML()

BlockListPager::getRestrictionListHTML ( stdClass  $row)
private

Get Restriction List HTML.

Parameters
stdClass$row
Returns
string

Definition at line 251 of file BlockListPager.php.

References $linkRenderer, $value, as, ContextSource\getLanguage(), SpecialPage\getTitleValueFor(), ContextSource\msg(), NS_MAIN, and Html\rawElement().

Referenced by formatValue().

◆ getTableClass()

BlockListPager::getTableClass ( )
protected

Definition at line 380 of file BlockListPager.php.

◆ getTotalAutoblocks()

BlockListPager::getTotalAutoblocks ( )

Get total number of autoblocks at any given time.

Returns
int Total number of unexpired active autoblocks

Definition at line 365 of file BlockListPager.php.

References $dbr, $res, and IndexPager\getDatabase().

Referenced by SpecialAutoblockList\showTotal().

◆ isFieldSortable()

BlockListPager::isFieldSortable (   $name)

Definition at line 392 of file BlockListPager.php.

◆ preprocessResults()

BlockListPager::preprocessResults (   $result)

Do a LinkBatch query to minimise database load when generating all these links.

Parameters
IResultWrapper$result

Definition at line 400 of file BlockListPager.php.

References as, NS_USER, NS_USER_TALK, and LinkBatch\setCaller().

Member Data Documentation

◆ $conds

BlockListPager::$conds
protected

Definition at line 34 of file BlockListPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $restrictions

Restriction [] BlockListPager::$restrictions = []
protected

Array of restrictions.

Definition at line 41 of file BlockListPager.php.


The documentation for this class was generated from the following file: