Use TablePager for prettified output. More...

Inheritance diagram for AllMessagesTablePager:

[legend]

Collaboration diagram for AllMessagesTablePager:

[legend]

Public Member Functions
	__construct ( $page, $conds, $langObj=null)

	buildForm ()

	formatRow ( $row)

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

	getAllMessages ( $descending)

	getCellAttrs ( $field, $value)
	Get any extra attributes to be applied to the given cell.

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

	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, $isSecond=false)

	getStartBody ()

	getTitle ()
	Get the Title object.

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

	reallyDoQuery ( $offset, $limit, $descending)
	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)

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

	getEmptyBody ()

	getEndBody ()

	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.

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

	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, ResultWrapper $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 ()
	Get the Config object.

	getContext ()
	Get the base IContextSource object.

	getLanguage ()
	Get the Language object.

	getOutput ()
	Get the OutputPage object.

	getRequest ()
	Get the WebRequest object.

	getSkin ()
	Get the Skin object.

	getStats ()
	Get the Stats object.

	getTiming ()
	Get the Timing object.

	getUser ()
	Get the User object.

	getWikiPage ()
	Get the WikiPage object.

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)
	Set the IContextSource object.

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

	$mLimitsShown

Public Attributes inherited from IndexPager
	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

	$mDefaultLimit = 50

	$mIsBackwards

	$mIsFirst
	True if the current result set is the first one.

	$mIsLast

	$mLimit

	$mLimitsShown = [ 20, 50, 100, 250, 500 ]

	$mOffset

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

ResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Constants for the $mDefaultDirection field.

const	DIR_DESCENDING = true

Protected Attributes
	$displayPrefix

	$filter

	$langcode

	$prefix

Protected Attributes inherited from TablePager
	$mCurrentRow

	$mSort

Protected Attributes inherited from IndexPager
	$mDefaultQuery

	$mExtraSortFields
	An array of secondary columns to order by.

	$mFirstShown

	$mIncludeOffset = false
	Whether to include the offset in the query.

	$mIndexField
	The index to actually be used for ordering.

	$mLastShown

	$mNavigationBar

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

	$mPastTheEndIndex

Additional Inherited Members
Protected Member Functions inherited from TablePager
	getCurrentRow ()

	getNavClass ()

	getSortHeaderClass ()

	getTableClass ()

Protected Member Functions inherited from IndexPager
	buildQueryInfo ( $offset, $limit, $descending)
	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().

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

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

Constructor & Destructor Documentation

◆ __construct()

AllMessagesTablePager::__construct	(	$page,
		$conds,
		$langObj = `null`
	)

Definition at line 44 of file AllMessagesTablePager.php.

References $langcode, $page, $prefix, $request, $wgContLang, IndexPager\DIR_DESCENDING, ContextSource\getLanguage(), ContextSource\getRequest(), global, ContextSource\msg(), and NS_MEDIAWIKI.

Member Function Documentation

◆ buildForm()

AllMessagesTablePager::buildForm ( )

Definition at line 92 of file AllMessagesTablePager.php.

References $out, Xml\closeElement(), Xml\fieldset(), ContextSource\getConfig(), TablePager\getHiddenFields(), TablePager\getLimitSelect(), getTitle(), Xml\input(), Xml\label(), Xml\languageSelector(), ContextSource\msg(), Xml\openElement(), Xml\radioLabel(), Xml\submitButton(), text, and wfMessage().

◆ formatRow()

AllMessagesTablePager::formatRow ( $row )

Access:\n protected

Parameters

stdClass $row

Returns: string HTML

Reimplemented from TablePager.

Definition at line 351 of file AllMessagesTablePager.php.

References $s, formatValue(), getCellAttrs(), getRowAttrs(), Xml\openElement(), and Xml\tags().

◆ 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 299 of file AllMessagesTablePager.php.

References $title, $value, ContextSource\getLanguage(), Linker\link(), Linker\linkKnown(), Linker\makeExternalLink(), ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, plain, text, and wfArrayToCgi().

Referenced by formatRow().

◆ getAllMessages()

AllMessagesTablePager::getAllMessages ( $descending )

Definition at line 170 of file AllMessagesTablePager.php.

Referenced by reallyDoQuery().

◆ getCellAttrs()

AllMessagesTablePager::getCellAttrs	(	$field,
		$value
	)

Get any extra attributes to be applied to the given cell.

Don't take this as an excuse to hardcode styles; use classes and CSS instead. Row context is available in $this->mCurrentRow

Access:\n protected

Parameters

string	$field	The column
string	$value	The cell contents

Returns: array Array of attr => value

Reimplemented from TablePager.

Definition at line 385 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 196 of file AllMessagesTablePager.php.

References $dbr, $langcode, $res, $s, $title, as, 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 415 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 400 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 419 of file AllMessagesTablePager.php.

◆ getRowAttrs()

AllMessagesTablePager::getRowAttrs	(	$row,
		$isSecond = `false`
	)

Definition at line 371 of file AllMessagesTablePager.php.

References ContextSource\getLanguage().

Referenced by formatRow().

◆ getStartBody()

AllMessagesTablePager::getStartBody ( )

Access:\n protected

Returns: string

Reimplemented from TablePager.

Definition at line 277 of file AllMessagesTablePager.php.

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

◆ getTitle()

AllMessagesTablePager::getTitle ( )

Get the Title object.

Since: 1.18

Returns: Title|null

Reimplemented from ContextSource.

Definition at line 407 of file AllMessagesTablePager.php.

References SpecialPage\getTitleFor().

Referenced by buildForm().

◆ 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 411 of file AllMessagesTablePager.php.

◆ reallyDoQuery()

AllMessagesTablePager::reallyDoQuery	(	$offset,
		$limit,
		$descending
	)

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

Returns: FakeResultWrapper

Reimplemented from IndexPager.

Definition at line 244 of file AllMessagesTablePager.php.

References $count, $limit, as, getAllMessages(), getCustomisedStatuses(), and wfMessage().

Member Data Documentation

◆ $custom

null bool AllMessagesTablePager::$custom

Definition at line 42 of file AllMessagesTablePager.php.

◆ $displayPrefix

AllMessagesTablePager::$displayPrefix

protected

Definition at line 30 of file AllMessagesTablePager.php.

◆ $filter

AllMessagesTablePager::$filter

protected

Definition at line 30 of file AllMessagesTablePager.php.

◆ $lang

Language AllMessagesTablePager::$lang

Definition at line 37 of file AllMessagesTablePager.php.

◆ $langcode

AllMessagesTablePager::$langcode

protected

Definition at line 30 of file AllMessagesTablePager.php.

Referenced by __construct(), and getCustomisedStatuses().

◆ $mLimitsShown

AllMessagesTablePager::$mLimitsShown

Definition at line 32 of file AllMessagesTablePager.php.

◆ $prefix

AllMessagesTablePager::$prefix

protected

Definition at line 30 of file AllMessagesTablePager.php.

Referenced by __construct().

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 Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildForm()

◆ formatRow()

◆ formatValue()

◆ getAllMessages()

◆ getCellAttrs()

◆ getCustomisedStatuses()

◆ getDefaultSort()

◆ getFieldNames()

◆ getQueryInfo()

◆ getRowAttrs()

◆ getStartBody()

◆ getTitle()

◆ isFieldSortable()

◆ reallyDoQuery()

Member Data Documentation

◆ $custom

◆ $displayPrefix

◆ $filter

◆ $lang

◆ $langcode

◆ $mLimitsShown

◆ $prefix