Inherits MediaWiki\Pager\AlphabeticPager.

Collaboration diagram for MediaWiki\Pager\CategoryPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, LinkBatchFactory $linkBatchFactory, LinkRenderer $linkRenderer, IConnectionProvider $dbProvider, $from)

	formatRow ( $result)
	Returns an HTML string representing the result row $row.

	getBody ()
	Get the formatted result list.

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

	getIndexField ()
	Returns the name of the index field.

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

	getStartForm ( $from)

Public Member Functions inherited from MediaWiki\Pager\AlphabeticPager
	getNavigationBar ()

Public Member Functions inherited from MediaWiki\Pager\IndexPager
	__construct (?IContextSource $context=null, ?LinkRenderer $linkRenderer=null)

	doQuery ()
	Do the query, using information from the object context.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

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

	getNavigationBuilder ()

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

	getOffsetQuery ()
	Get the current offset for the URL query parameter.

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

	getResult ()

	getResultOffset ()

	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 MediaWiki\Context\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.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

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

	getLanguage ()

	getLanguageCode ()

	getOutput ()

	getRequest ()

	getSkin ()

	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)

Additional Inherited Members
Public Attributes inherited from MediaWiki\Pager\IndexPager
IReadableDatabase	$mDb

bool null	$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 inherited from MediaWiki\Pager\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.

	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.

	getEmptyBody ()
	Hook into getBody(), for the bit between the start and the end when there are no rows.

	getEndBody ()
	Hook into getBody() for the end of the list.

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

	getFooter ()
	Classes can extend to output a footer at the bottom of the pager list.

	getLinkRenderer ()

	getRow ( $row)
	Get the HTML of a pager row.

	getSqlComment ()
	Get some text to go in brackets in the "function name" part of the SQL comment.

	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start.

	isNavigationBarShown ()
	Returns whether to show the "navigation bar".

	makeLink ( $text, ?array $query=null, $type=null)
	Make a self-link.

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

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

Protected Attributes inherited from MediaWiki\Pager\IndexPager
array null	$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 null	$mNavigationBar

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

array	$mPastTheEndIndex

Detailed Description

Definition at line 36 of file CategoryPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\CategoryPager::__construct	(	IContextSource	$context,
		LinkBatchFactory	$linkBatchFactory,
		LinkRenderer	$linkRenderer,
		IConnectionProvider	$dbProvider,
			$from )

Parameters

IContextSource	$context
LinkBatchFactory	$linkBatchFactory
LinkRenderer	$linkRenderer
IConnectionProvider	$dbProvider
string	$from

Definition at line 47 of file CategoryPager.php.

References Wikimedia\Rdbms\IConnectionProvider\getReplicaDatabase(), NS_CATEGORY, MediaWiki\Pager\IndexPager\setIncludeOffset(), and MediaWiki\Pager\IndexPager\setOffset().

Member Function Documentation

◆ formatRow()

MediaWiki\Pager\CategoryPager::formatRow ( $row )

Returns an HTML string representing the result row $row.

Rows will be concatenated and returned by getBody()

Parameters

array | stdClass $row Database row

Returns: string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 100 of file CategoryPager.php.

References MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Pager\IndexPager\getLinkRenderer(), MediaWiki\Context\ContextSource\msg(), and NS_CATEGORY.

◆ getBody()

MediaWiki\Pager\CategoryPager::getBody ( )

Get the formatted result list.

Calls getStartBody(), formatRow() and getEndBody(), concatenates the results and returns them.

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 86 of file CategoryPager.php.

References NS_CATEGORY.

◆ getDefaultQuery()

MediaWiki\Pager\CategoryPager::getDefaultQuery ( )

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

By default, all parameters passed in the URL are used, apart from a few exceptions.

Stability: stable: to override

Returns: array Associative array

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 78 of file CategoryPager.php.

References MediaWiki\Pager\IndexPager\$mDefaultQuery.

◆ getIndexField()

MediaWiki\Pager\CategoryPager::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[]

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 74 of file CategoryPager.php.

◆ getQueryInfo()

MediaWiki\Pager\CategoryPager::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 MediaWiki\Pager\IndexPager.

Definition at line 66 of file CategoryPager.php.

◆ getStartForm()

MediaWiki\Pager\CategoryPager::getStartForm ( $from )

Definition at line 109 of file CategoryPager.php.

References MediaWiki\Context\ContextSource\getContext(), and NS_CATEGORY.

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

includes/specials/pagers/CategoryPager.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatRow()

◆ getBody()

◆ getDefaultQuery()

◆ getIndexField()

◆ getQueryInfo()

◆ getStartForm()