Inheritance diagram for BlockListPager:

[legend]

Collaboration diagram for BlockListPager:

[legend]

Public Member Functions
	__construct ( $page, $conds)

	formatValue ( $name, $value)
	Format a table cell.

	getDefaultSort ()
	The database field name used as a default sort order.

	getFieldNames ()
	An array mapping database field names to a textual description of the field name, for use in the table header.

	getIndexField ()

	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.

	getTotalAutoblocks ()
	Get total number of autoblocks at any given time.

	isFieldSortable ( $name)
	Return true if the named field should be sortable by the UI, false otherwise.

	preprocessResults ( $result)
	Do a LinkBatch query to minimise database load when generating all these links.

Public Member Functions inherited from TablePager
	__construct (IContextSource $context=null)

	formatRow ( $row)

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

	getCellAttrs ( $field, $value)
	Get any extra attributes to be applied to the given cell.

	getEmptyBody ()

	getFullOutput ()
	Get the formatted result list, with navigation bars.

	getHiddenFields ( $blacklist=[])
	Get \<input type="hidden"\> elements for use in a method="get" form.

	getLimitDropdown ()
	Gets a limit selection dropdown.

	getLimitForm ()
	Get a form containing a limit selection dropdown.

	getLimitSelect ( $attribs=[])
	Get a "<select>" element which has options for each of the allowed limits.

	getLimitSelectList ()
	Get a list of items to show in a "<select>" element of limits.

	getModuleStyles ()
	ResourceLoader modules that must be loaded to provide correct styling for this pager.

	getNavigationBar ()
	A navigation bar with images.

	getRowAttrs ( $row)
	Get attributes to be applied to the given row.

	getRowClass ( $row)
	Get a class name to be applied to the given row.

Public Member Functions inherited from IndexPager
	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.

	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.

	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)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Protected Member Functions
	getTableClass ()
	TablePager relies on `mw-datatable` for styling, see T214208.

Protected Member Functions inherited from TablePager
	getCurrentRow ()

	getEndBody ()

	getNavClass ()

	getSortHeaderClass ()

	getStartBody ()

Protected Member Functions inherited from IndexPager
	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.

	getExtraSortFields ()
	This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField().

Protected Attributes
	$conds

Restriction[]	$restrictions = []
	Array of restrictions.

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.

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

Private Member Functions
	getRestrictionListHTML (stdClass $row)
	Get Restriction List HTML.

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)

Static Protected Member Functions inherited from IndexPager
static	oppositeOrder ( $order)

Detailed Description

Definition at line 31 of file BlockListPager.php.

Constructor & Destructor Documentation

◆ __construct()

BlockListPager::__construct	(		$page,
			$conds )

Parameters

SpecialPage	$page
array	$conds

Definition at line 46 of file BlockListPager.php.

References $conds, and IndexPager\DIR_DESCENDING.

Member Function Documentation

◆ formatValue()

BlockListPager::formatValue	(		$name,
			$value )

Format a table cell.

The return value should be HTML, but use an empty string not   for empty cells. Do not include the

and .

The current result row is available as $this->mCurrentRow, in case you need more context.

Access:\n protected

Parameters

string	$name	The database field name
string	$value	The value retrieved from the database

Reimplemented from TablePager.

Definition at line 72 of file BlockListPager.php.

References $keys, $linkRenderer, TablePager\$mCurrentRow, $type, $value, and(), Linker\formatComment(), ContextSource\getConfig(), ContextSource\getLanguage(), getRestrictionListHTML(), ContextSource\getUser(), list, ContextSource\msg(), Block\parseTarget(), Linker\TOOL_LINKS_NOBLOCK, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, Linker\userLink(), and Linker\userToolLinks().

◆ getDefaultSort()

BlockListPager::getDefaultSort ( )

The database field name used as a default sort order.

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 386 of file BlockListPager.php.

◆ getFieldNames()

BlockListPager::getFieldNames ( )

An array mapping database field names to a textual description of the field name, for use in the table header.

The description should be plain text, it will be HTML-escaped later.

Returns: array

Reimplemented from TablePager.

Definition at line 52 of file BlockListPager.php.

References ContextSource\msg().

◆ getIndexField()

BlockListPager::getIndexField ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 382 of file BlockListPager.php.

◆ getQueryInfo()

BlockListPager::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 314 of file BlockListPager.php.

References $conds, and(), IndexPager\getDatabase(), and ContextSource\getUser().

◆ getRestrictionListHTML()

BlockListPager::getRestrictionListHTML ( stdClass $row )

private

Get Restriction List HTML.

Parameters

stdClass $row

Returns: string

Definition at line 250 of file BlockListPager.php.

References $value, ContextSource\getLanguage(), Linker\link(), ContextSource\msg(), and NS_MAIN.

Referenced by formatValue().

◆ getTableClass()

BlockListPager::getTableClass ( )

protected

TablePager relies on mw-datatable for styling, see T214208.

Returns: string

Reimplemented from TablePager.

Definition at line 378 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 363 of file BlockListPager.php.

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

Referenced by SpecialAutoblockList\showTotal().

◆ isFieldSortable()

BlockListPager::isFieldSortable ( $field )

Return true if the named field should be sortable by the UI, false otherwise.

Parameters

string $field

Reimplemented from TablePager.

Definition at line 390 of file BlockListPager.php.

◆ preprocessResults()

BlockListPager::preprocessResults ( $result )

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

Parameters

IResultWrapper $result

Reimplemented from IndexPager.

Definition at line 398 of file BlockListPager.php.

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

Member Data Documentation

◆ $conds

BlockListPager::$conds

protected

Definition at line 33 of file BlockListPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $restrictions

Restriction [] BlockListPager::$restrictions = []

protected

Array of restrictions.

Definition at line 40 of file BlockListPager.php.

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

includes/specials/pagers/BlockListPager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatValue()

◆ getDefaultSort()

◆ getFieldNames()

◆ getIndexField()

◆ getQueryInfo()

◆ getRestrictionListHTML()

◆ getTableClass()

◆ getTotalAutoblocks()

◆ isFieldSortable()

◆ preprocessResults()

Member Data Documentation

◆ $conds

◆ $restrictions