Inheritance diagram for ProtectedPagesPager:

[legend]

Collaboration diagram for ProtectedPagesPager:

[legend]

Public Member Functions
	__construct ( $form, $conds, $type, $level, $namespace, $sizetype, $size, $indefonly, $cascadeonly, $noredirect, LinkRenderer $linkRenderer, LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, CommentStore $commentStore, UserCache $userCache)

	formatValue ( $field, $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.

	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc.

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)

Public Attributes
	$mConds

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)

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 ( $field)
	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.

Private Attributes
	$cascadeonly

CommentStore	$commentStore

	$indefonly

	$level

LinkBatchFactory	$linkBatchFactory

	$namespace

	$noredirect

	$size

	$sizetype

	$type

UserCache	$userCache

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

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

Detailed Description

Definition at line 26 of file ProtectedPagesPager.php.

Constructor & Destructor Documentation

◆ __construct()

ProtectedPagesPager::__construct	(		$form,
			$conds,
			$type,
			$level,
			$namespace,
			$sizetype,
			$size,
			$indefonly,
			$cascadeonly,
			$noredirect,
		LinkRenderer	$linkRenderer,
		LinkBatchFactory	$linkBatchFactory,
		ILoadBalancer	$loadBalancer,
		CommentStore	$commentStore,
		UserCache	$userCache
	)

Parameters

SpecialPage	$form
array	$conds
string	$type
string	$level
int	$namespace
string	$sizetype
int	$size
bool	$indefonly
bool	$cascadeonly
bool	$noredirect
LinkRenderer	$linkRenderer
LinkBatchFactory	$linkBatchFactory
ILoadBalancer	$loadBalancer
CommentStore	$commentStore
UserCache	$userCache

Definition at line 57 of file ProtectedPagesPager.php.

References $cascadeonly, $commentStore, $indefonly, $level, $linkBatchFactory, IndexPager\$linkRenderer, $noredirect, $size, $sizetype, $type, $userCache, and Wikimedia\Rdbms\ILoadBalancer\getConnectionRef().

Member Function Documentation

◆ formatValue()

ProtectedPagesPager::formatValue	(	$field,
		$value
	)

Parameters

string	$field
string \| null	$value

Returns: string HTML

Exceptions

MWException

Reimplemented from TablePager.

Definition at line 144 of file ProtectedPagesPager.php.

References IndexPager\$linkRenderer, TablePager\$mCurrentRow, $title, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, Linker\formatComment(), Linker\formatRevisionSize(), ContextSource\getAuthority(), ContextSource\getContext(), Linker\getInvalidTitleDescription(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), ContextSource\getUser(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), ContextSource\msg(), Linker\userLink(), and Linker\userToolLinks().

◆ getDefaultSort()

ProtectedPagesPager::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 358 of file ProtectedPagesPager.php.

◆ getFieldNames()

ProtectedPagesPager::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 118 of file ProtectedPagesPager.php.

References ContextSource\msg().

◆ getIndexField()

ProtectedPagesPager::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 354 of file ProtectedPagesPager.php.

◆ getQueryInfo()

ProtectedPagesPager::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 276 of file ProtectedPagesPager.php.

References $dbr, $mConds, $size, and IndexPager\getDatabase().

◆ getTableClass()

ProtectedPagesPager::getTableClass ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from TablePager.

Definition at line 350 of file ProtectedPagesPager.php.

◆ isFieldSortable()

ProtectedPagesPager::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 362 of file ProtectedPagesPager.php.

◆ preprocessResults()

ProtectedPagesPager::preprocessResults ( $result )

Pre-process results; useful for performing batch existence checks, etc.

Stability: stable: to override

Parameters

IResultWrapper $result

Reimplemented from IndexPager.

Definition at line 91 of file ProtectedPagesPager.php.

References NS_USER, and NS_USER_TALK.

Member Data Documentation

◆ $cascadeonly

ProtectedPagesPager::$cascadeonly

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $commentStore

CommentStore ProtectedPagesPager::$commentStore

private

Definition at line 35 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $indefonly

ProtectedPagesPager::$indefonly

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $level

ProtectedPagesPager::$level

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory ProtectedPagesPager::$linkBatchFactory

private

Definition at line 32 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $mConds

ProtectedPagesPager::$mConds

Definition at line 28 of file ProtectedPagesPager.php.

Referenced by getQueryInfo().

◆ $namespace

ProtectedPagesPager::$namespace

private

Definition at line 29 of file ProtectedPagesPager.php.

◆ $noredirect

ProtectedPagesPager::$noredirect

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $size

ProtectedPagesPager::$size

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct(), and getQueryInfo().

◆ $sizetype

ProtectedPagesPager::$sizetype

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $type

ProtectedPagesPager::$type

private

Definition at line 29 of file ProtectedPagesPager.php.

Referenced by __construct().

◆ $userCache

UserCache ProtectedPagesPager::$userCache

private

Definition at line 38 of file ProtectedPagesPager.php.

Referenced by __construct().

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

includes/specials/pagers/ProtectedPagesPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatValue()

◆ getDefaultSort()

◆ getFieldNames()

◆ getIndexField()

◆ getQueryInfo()

◆ getTableClass()

◆ isFieldSortable()

◆ preprocessResults()

Member Data Documentation

◆ $cascadeonly

◆ $commentStore

◆ $indefonly

◆ $level

◆ $linkBatchFactory

◆ $mConds

◆ $namespace

◆ $noredirect

◆ $size

◆ $sizetype

◆ $type

◆ $userCache