Use TablePager for prettified output. More...

Collaboration diagram for MediaWiki\Pager\AllMessagesTablePager:

[legend]

Public Member Functions
	__construct (IContextSource $context, Language $contentLanguage, LanguageFactory $languageFactory, LinkRenderer $linkRenderer, IConnectionProvider $dbProvider, LocalisationCache $localisationCache, FormOptions $opts)

	formatRow ( $row)

	formatValue ( $field, $value)

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

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

	getTitle ()

	reallyDoQuery ( $offset, $limit, $order)
	This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.

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

	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.

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

	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. Stability: stable to override Since 1.38 Returns string[]

	getNavigationBar ()
	A navigation bar with images.

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

	getBody ()
	Get the formatted result list.

	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.

	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 ()

	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 ()

	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)

Static Public Member Functions
static	getCustomisedStatuses ( $messageNames, $langcode='en', $foreign=false, IReadableDatabase $dbr=null)
	Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Public Attributes
null bool	$custom

Language	$lang

Public Attributes inherited from MediaWiki\Pager\IndexPager
IReadableDatabase	$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
	getCellAttrs ( $field, $value)

	getEndBody ()

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

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

	getStartBody ()

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

Protected Member Functions inherited from MediaWiki\Pager\TablePager
	getCurrentRow ()

	getEmptyBody ()

	getNavClass ()

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

	getSortHeaderClass ()

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

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.

	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.

	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.

Protected Attributes
bool	$foreign

string false	$prefix

string	$suffix

Protected Attributes inherited from MediaWiki\Pager\TablePager
stdClass	$mCurrentRow

string	$mSort

Protected Attributes inherited from MediaWiki\Pager\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

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

Detailed Description

Use TablePager for prettified output.

We have to pretend that we're getting data from a table when in fact not all of it comes from the database.

Definition at line 48 of file AllMessagesTablePager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\AllMessagesTablePager::__construct	(	IContextSource	$context,
		Language	$contentLanguage,
		LanguageFactory	$languageFactory,
		LinkRenderer	$linkRenderer,
		IConnectionProvider	$dbProvider,
		LocalisationCache	$localisationCache,
		FormOptions	$opts )

Parameters

IContextSource	$context
Language	$contentLanguage
LanguageFactory	$languageFactory
LinkRenderer	$linkRenderer
IConnectionProvider	$dbProvider
LocalisationCache	$localisationCache
FormOptions	$opts

Definition at line 86 of file AllMessagesTablePager.php.

References MediaWiki\Pager\AllMessagesTablePager\$prefix, MediaWiki\Pager\IndexPager\DIR_DESCENDING, MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Languages\LanguageFactory\getRawLanguage(), Wikimedia\Rdbms\IConnectionProvider\getReplicaDatabase(), MediaWiki\Html\FormOptions\getValue(), and NS_MEDIAWIKI.

Member Function Documentation

◆ formatRow()

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

Parameters

stdClass $row

Returns: string HTML

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 340 of file AllMessagesTablePager.php.

References MediaWiki\Pager\AllMessagesTablePager\formatValue(), MediaWiki\Pager\AllMessagesTablePager\getCellAttrs(), and MediaWiki\Pager\AllMessagesTablePager\getRowAttrs().

◆ formatValue()

MediaWiki\Pager\AllMessagesTablePager::formatValue	(		$field,
			$value )

Parameters

string	$field
string \| null	$value

Returns: string HTML

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 287 of file AllMessagesTablePager.php.

References MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Pager\IndexPager\getLinkRenderer(), MediaWiki\Context\ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfArrayToCgi().

Referenced by MediaWiki\Pager\AllMessagesTablePager\formatRow().

◆ getCellAttrs()

MediaWiki\Pager\AllMessagesTablePager::getCellAttrs	(		$field,
			$value )

protected

Parameters

string	$field
string	$value

Returns: array HTML attributes

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 369 of file AllMessagesTablePager.php.

Referenced by MediaWiki\Pager\AllMessagesTablePager\formatRow().

◆ getCustomisedStatuses()

static MediaWiki\Pager\AllMessagesTablePager::getCustomisedStatuses	(		$messageNames,
			$langcode = 'en',
			$foreign = false,
		IReadableDatabase	$dbr = null )

static

Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Returns [ 'pages' => ..., 'talks' => ... ], where the subarrays have an entry for each existing page, with the key being the message name and value arbitrary.

Since: 1.36 Added $dbr parameter

Parameters

array	$messageNames
string	$langcode	What language code
bool	$foreign	Whether the $langcode is not the content language
IReadableDatabase \| null	$dbr

Returns: array A 'pages' and 'talks' array with the keys of existing pages

Definition at line 165 of file AllMessagesTablePager.php.

References MediaWiki\Pager\AllMessagesTablePager\$foreign, MediaWiki\MediaWikiServices\getInstance(), NS_MEDIAWIKI, and NS_MEDIAWIKI_TALK.

Referenced by MediaWiki\Pager\AllMessagesTablePager\reallyDoQuery().

◆ getDefaultSort()

MediaWiki\Pager\AllMessagesTablePager::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 MediaWiki\Pager\TablePager.

Definition at line 404 of file AllMessagesTablePager.php.

◆ getEndBody()

MediaWiki\Pager\AllMessagesTablePager::getEndBody ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 278 of file AllMessagesTablePager.php.

◆ getFieldNames()

MediaWiki\Pager\AllMessagesTablePager::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 MediaWiki\Pager\TablePager.

Definition at line 389 of file AllMessagesTablePager.php.

References MediaWiki\Context\ContextSource\msg().

◆ getQueryInfo()

MediaWiki\Pager\AllMessagesTablePager::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 408 of file AllMessagesTablePager.php.

◆ getRowAttrs()

MediaWiki\Pager\AllMessagesTablePager::getRowAttrs ( $row )

protected

Get attributes to be applied to the given row.

Stability: stable: to override

Parameters

stdClass $row The database result row

Returns: array Array of attribute => value

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 360 of file AllMessagesTablePager.php.

Referenced by MediaWiki\Pager\AllMessagesTablePager\formatRow().

◆ getStartBody()

MediaWiki\Pager\AllMessagesTablePager::getStartBody ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 257 of file AllMessagesTablePager.php.

References MediaWiki\Pager\TablePager\getTableClass(), MediaWiki\Context\ContextSource\msg(), and MediaWiki\Html\Html\openElement().

◆ getTitle()

MediaWiki\Pager\AllMessagesTablePager::getTitle ( )

Since: 1.18

Stability: stable: to override

Returns: Title|null

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 396 of file AllMessagesTablePager.php.

References MediaWiki\SpecialPage\SpecialPage\getTitleFor().

◆ isFieldSortable()

MediaWiki\Pager\AllMessagesTablePager::isFieldSortable ( $field )

protected

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

Parameters

string $field

Returns: bool

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 400 of file AllMessagesTablePager.php.

◆ reallyDoQuery()

MediaWiki\Pager\AllMessagesTablePager::reallyDoQuery	(	$offset,
		$limit,
		$order )

This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.

Parameters

string	$offset
int	$limit
bool	$order

Returns: IResultWrapper

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 218 of file AllMessagesTablePager.php.

References MediaWiki\Pager\AllMessagesTablePager\getCustomisedStatuses(), MediaWiki\Context\ContextSource\msg(), and MediaWiki\Pager\IndexPager\QUERY_ASCENDING.

Member Data Documentation

◆ $custom

null bool MediaWiki\Pager\AllMessagesTablePager::$custom

Definition at line 73 of file AllMessagesTablePager.php.

◆ $foreign

bool MediaWiki\Pager\AllMessagesTablePager::$foreign

protected

Definition at line 53 of file AllMessagesTablePager.php.

Referenced by MediaWiki\Pager\AllMessagesTablePager\getCustomisedStatuses().

◆ $lang

Language MediaWiki\Pager\AllMessagesTablePager::$lang

Definition at line 68 of file AllMessagesTablePager.php.

◆ $prefix

string false MediaWiki\Pager\AllMessagesTablePager::$prefix

protected

Definition at line 58 of file AllMessagesTablePager.php.

Referenced by MediaWiki\Pager\AllMessagesTablePager\__construct().

◆ $suffix

string MediaWiki\Pager\AllMessagesTablePager::$suffix

protected

Definition at line 63 of file AllMessagesTablePager.php.

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

includes/specials/pagers/AllMessagesTablePager.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatRow()

◆ formatValue()

◆ getCellAttrs()

◆ getCustomisedStatuses()

◆ getDefaultSort()

◆ getEndBody()

◆ getFieldNames()

◆ getQueryInfo()

◆ getRowAttrs()

◆ getStartBody()

◆ getTitle()

◆ isFieldSortable()

◆ reallyDoQuery()

Member Data Documentation

◆ $custom

◆ $foreign

◆ $lang

◆ $prefix

◆ $suffix