Use TablePager for prettified output. More...

Inheritance diagram for AllMessagesTablePager:

[legend]

Collaboration diagram for AllMessagesTablePager:

[legend]

Public Member Functions
	__construct (IContextSource $context=null, FormOptions $opts, LinkRenderer $linkRenderer)

	formatRow ( $row)

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

	getAllMessages ( $descending)

	getCellAttrs ( $field, $value)

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

	getEndBody ()

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

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

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

	getTitle ()

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

	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 TablePager
	__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

	getEmptyBody ()

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

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

	getIndexField ()

	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.

	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.

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

	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)
	Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Public Attributes
null bool	$custom

Language	$lang

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

Protected Member Functions inherited from TablePager
	getCurrentRow ()

	getNavClass ()

	getSortHeaderClass ()

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

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.

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

	getLinkRenderer ()

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

Protected Attributes
bool	$foreign

string	$langcode

string	$prefix

string	$suffix

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

Additional Inherited Members
Static Protected Member Functions inherited from 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 32 of file AllMessagesTablePager.php.

Constructor & Destructor Documentation

◆ __construct()

AllMessagesTablePager::__construct	(	IContextSource	$context = `null`,
		FormOptions	$opts,
		LinkRenderer	$linkRenderer
	)

Parameters

IContextSource \| null	$context
FormOptions	$opts
LinkRenderer	$linkRenderer

Definition at line 69 of file AllMessagesTablePager.php.

References ContextSource\$context, $filter, $langcode, IndexPager\$linkRenderer, $prefix, IndexPager\DIR_DESCENDING, ContextSource\getLanguage(), FormOptions\getValue(), NS_MEDIAWIKI, and wfGetLangObj().

Member Function Documentation

◆ formatRow()

AllMessagesTablePager::formatRow ( $row )

Parameters

stdClass $row

Returns: string HTML

Reimplemented from TablePager.

Definition at line 297 of file AllMessagesTablePager.php.

References $s, formatValue(), getCellAttrs(), and getRowAttrs().

◆ formatValue()

AllMessagesTablePager::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 246 of file AllMessagesTablePager.php.

References IndexPager\$linkRenderer, $title, ContextSource\getLanguage(), IndexPager\getLinkRenderer(), MediaWiki\Linker\LinkRenderer\makeBrokenLink(), Linker\makeExternalLink(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfArrayToCgi().

Referenced by formatRow().

◆ getAllMessages()

AllMessagesTablePager::getAllMessages ( $descending )

Definition at line 112 of file AllMessagesTablePager.php.

Referenced by reallyDoQuery().

◆ getCellAttrs()

AllMessagesTablePager::getCellAttrs	(	$field,
		$value
	)

Parameters

string	$field
string	$value

Returns: array HTML attributes

Reimplemented from TablePager.

Definition at line 326 of file AllMessagesTablePager.php.

Referenced by formatRow().

◆ getCustomisedStatuses()

static AllMessagesTablePager::getCustomisedStatuses	(	$messageNames,
		$langcode = `'en'`,
		$foreign = `false`
	)

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.

Parameters

array	$messageNames
string	$langcode	What language code
bool	$foreign	Whether the $langcode is not the content language

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

Definition at line 138 of file AllMessagesTablePager.php.

References $dbr, $foreign, $langcode, $res, $s, $title, DB_REPLICA, NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfGetDB().

Referenced by ApiQueryAllMessages\execute(), DeleteEqualMessages\fetchMessageInfo(), and reallyDoQuery().

◆ getDefaultSort()

AllMessagesTablePager::getDefaultSort ( )

The database field name used as a default sort order.

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 361 of file AllMessagesTablePager.php.

◆ getEndBody()

AllMessagesTablePager::getEndBody ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 242 of file AllMessagesTablePager.php.

◆ getFieldNames()

AllMessagesTablePager::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 346 of file AllMessagesTablePager.php.

References ContextSource\msg().

◆ getQueryInfo()

AllMessagesTablePager::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 365 of file AllMessagesTablePager.php.

◆ getRowAttrs()

AllMessagesTablePager::getRowAttrs ( $row )

Get attributes to be applied to the given row.

Access:\n protected

Parameters

object $row The database result row

Returns: array Array of attribute => value

Reimplemented from TablePager.

Definition at line 317 of file AllMessagesTablePager.php.

Referenced by formatRow().

◆ getStartBody()

AllMessagesTablePager::getStartBody ( )

protected

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 220 of file AllMessagesTablePager.php.

References TablePager\getTableClass(), and ContextSource\msg().

◆ getTitle()

AllMessagesTablePager::getTitle ( )

Since: 1.18

Returns: Title|null

Reimplemented from ContextSource.

Definition at line 353 of file AllMessagesTablePager.php.

◆ isFieldSortable()

AllMessagesTablePager::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 357 of file AllMessagesTablePager.php.

◆ reallyDoQuery()

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: FakeResultWrapper

Reimplemented from IndexPager.

Definition at line 186 of file AllMessagesTablePager.php.

References getAllMessages(), getCustomisedStatuses(), ContextSource\msg(), and IndexPager\QUERY_ASCENDING.

Member Data Documentation

◆ $custom

null bool AllMessagesTablePager::$custom

Definition at line 62 of file AllMessagesTablePager.php.

◆ $foreign

bool AllMessagesTablePager::$foreign

protected

Definition at line 42 of file AllMessagesTablePager.php.

Referenced by getCustomisedStatuses().

◆ $lang

Language AllMessagesTablePager::$lang

Definition at line 57 of file AllMessagesTablePager.php.

◆ $langcode

string AllMessagesTablePager::$langcode

protected

Definition at line 37 of file AllMessagesTablePager.php.

Referenced by __construct(), and getCustomisedStatuses().

◆ $prefix

string AllMessagesTablePager::$prefix

protected

Definition at line 47 of file AllMessagesTablePager.php.

Referenced by __construct().

◆ $suffix

string AllMessagesTablePager::$suffix

protected

Definition at line 52 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()

◆ getAllMessages()

◆ getCellAttrs()

◆ getCustomisedStatuses()

◆ getDefaultSort()

◆ getEndBody()

◆ getFieldNames()

◆ getQueryInfo()

◆ getRowAttrs()

◆ getStartBody()

◆ getTitle()

◆ isFieldSortable()

◆ reallyDoQuery()

Member Data Documentation

◆ $custom

◆ $foreign

◆ $lang

◆ $langcode

◆ $prefix

◆ $suffix