Inheritance diagram for BlockListPager:

[legend]

Collaboration diagram for BlockListPager:

[legend]

Public Member Functions
	__construct ( $page, $conds, LinkBatchFactory $linkBatchFactory, BlockRestrictionStore $blockRestrictionStore, ILoadBalancer $loadBalancer, SpecialPageFactory $specialPageFactory, CommentStore $commentStore, BlockUtils $blockUtils, BlockActionInfo $blockActionInfo)

	formatValue ( $name, $value)

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

	getIndexField ()
	Returns the name of the index field.If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=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.The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).Examples: Always paginate on the user field: 'user' Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ] Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ] Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ] Returns string\|string[]\|array[] Stability: stable to override

	getQueryInfo ()
	Provides all parameters needed for the main paged query.

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

	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, LinkRenderer $linkRenderer=null)

	formatRow ( $row)

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

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

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

	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.

Public Member Functions inherited from IndexPager
	doQuery ()
	Do the query, using information from the object context.

	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.

	getNumRows ()
	Get the number of rows in the result set.

	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links.

	getResult ()

	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.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	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)

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

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

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

Protected Member Functions inherited from TablePager
	getCellAttrs ( $field, $value)
	Get any extra attributes to be applied to the given cell.

	getCurrentRow ()

	getEmptyBody ()

	getEndBody ()

	getNavClass ()

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

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

	getSortHeaderClass ()

	getStartBody ()

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.

	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.

	getExtraSortFields ()
	Returns the names of secondary columns to order by in addition to the column in getIndexField().

	getLimitLinks ()

	getLinkRenderer ()

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

	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.

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.

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	$mNavigationBar

string null	$mOrderType
	For pages that support multiple types of ordering, which one to use.

array	$mPastTheEndIndex

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

Private Attributes
BlockActionInfo	$blockActionInfo

BlockRestrictionStore	$blockRestrictionStore

BlockUtils	$blockUtils

CommentStore	$commentStore

LinkBatchFactory	$linkBatchFactory

SpecialPageFactory	$specialPageFactory

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

Constructor & Destructor Documentation

◆ __construct()

BlockListPager::__construct	(		$page,
			$conds,
		LinkBatchFactory	$linkBatchFactory,
		BlockRestrictionStore	$blockRestrictionStore,
		ILoadBalancer	$loadBalancer,
		SpecialPageFactory	$specialPageFactory,
		CommentStore	$commentStore,
		BlockUtils	$blockUtils,
		BlockActionInfo	$blockActionInfo
	)

Parameters

SpecialPage	$page
array	$conds
LinkBatchFactory	$linkBatchFactory
BlockRestrictionStore	$blockRestrictionStore
ILoadBalancer	$loadBalancer
SpecialPageFactory	$specialPageFactory
CommentStore	$commentStore
BlockUtils	$blockUtils
BlockActionInfo	$blockActionInfo

Definition at line 79 of file BlockListPager.php.

References $blockActionInfo, $blockRestrictionStore, $blockUtils, $commentStore, $conds, $linkBatchFactory, $specialPageFactory, IndexPager\DIR_DESCENDING, and Wikimedia\Rdbms\ILoadBalancer\getConnectionRef().

Member Function Documentation

◆ formatValue()

BlockListPager::formatValue	(	$name,
		$value
	)

Parameters

string	$name
string \| null	$value

Returns: string

Reimplemented from TablePager.

Definition at line 128 of file BlockListPager.php.

References $keys, IndexPager\$linkRenderer, TablePager\$mCurrentRow, Linker\formatComment(), ContextSource\getAuthority(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), getRestrictionListHTML(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), ContextSource\msg(), User\newFromName(), Linker\TOOL_LINKS_NOBLOCK, Linker\userLink(), and Linker\userToolLinks().

◆ getDefaultSort()

BlockListPager::getDefaultSort ( )

The database field name used as a default sort order.

Note that this field will only be sorted on if isFieldSortable returns true for this field. If not (e.g. paginating on multiple columns), this should return empty string, and getIndexField should be overridden.

Returns: string

Reimplemented from TablePager.

Definition at line 459 of file BlockListPager.php.

◆ getFieldNames()

BlockListPager::getFieldNames ( )

protected

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: string[]

Reimplemented from TablePager.

Definition at line 102 of file BlockListPager.php.

References ContextSource\msg().

◆ getIndexField()

BlockListPager::getIndexField ( )

Returns the name of the index field.If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=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.The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).Examples:

Always paginate on the user field: 'user'
Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]

Returns: string|string[]|array[]

Stability: stable: to override

Stability: stable: to override

Reimplemented from TablePager.

Definition at line 455 of file BlockListPager.php.

◆ getQueryInfo()

BlockListPager::getQueryInfo ( )

Provides 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 390 of file BlockListPager.php.

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

◆ getRestrictionListHTML()

BlockListPager::getRestrictionListHTML ( stdClass $row )

private

Get Restriction List HTML.

Parameters

stdClass $row

Returns: string

Definition at line 310 of file BlockListPager.php.

References IndexPager\$linkRenderer, ContextSource\getConfig(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), MediaWiki\Linker\LinkRenderer\makeLink(), ContextSource\msg(), and NS_MAIN.

Referenced by formatValue().

◆ getTableClass()

BlockListPager::getTableClass ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from TablePager.

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

References $dbr, and IndexPager\getDatabase().

Referenced by SpecialAutoblockList\showTotal().

◆ isFieldSortable()

BlockListPager::isFieldSortable ( $field )

protected

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

Parameters

string $field

Returns: bool

Reimplemented from TablePager.

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

References $title, NS_USER, and NS_USER_TALK.

Member Data Documentation

◆ $blockActionInfo

BlockActionInfo BlockListPager::$blockActionInfo

private

Definition at line 66 of file BlockListPager.php.

Referenced by __construct().

◆ $blockRestrictionStore

BlockRestrictionStore BlockListPager::$blockRestrictionStore

private

Definition at line 54 of file BlockListPager.php.

Referenced by __construct().

◆ $blockUtils

BlockUtils BlockListPager::$blockUtils

private

Definition at line 63 of file BlockListPager.php.

Referenced by __construct().

◆ $commentStore

CommentStore BlockListPager::$commentStore

private

Definition at line 60 of file BlockListPager.php.

Referenced by __construct().

◆ $conds

BlockListPager::$conds

protected

Definition at line 41 of file BlockListPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $linkBatchFactory

LinkBatchFactory BlockListPager::$linkBatchFactory

private

Definition at line 51 of file BlockListPager.php.

Referenced by __construct().

◆ $restrictions

Restriction [] BlockListPager::$restrictions = []

protected

Array of restrictions.

Definition at line 48 of file BlockListPager.php.

◆ $specialPageFactory

SpecialPageFactory BlockListPager::$specialPageFactory

private

Definition at line 57 of file BlockListPager.php.

Referenced by __construct().

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

Private Attributes

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

◆ $blockActionInfo

◆ $blockRestrictionStore

◆ $blockUtils

◆ $commentStore

◆ $conds

◆ $linkBatchFactory

◆ $restrictions

◆ $specialPageFactory