Table-based display with a user-selectable sort order. More...

Inheritance diagram for TablePager:

[legend]

Collaboration diagram for TablePager:

[legend]

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

	formatRow ( $row)

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

	getBody ()
	Get the formatted result list.

	getBodyOutput ()
	Get the formatted result list.

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

	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.

	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.

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

	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)

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

	getCurrentRow ()

	getEmptyBody ()

	getEndBody ()

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

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

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

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

Protected Attributes
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

Private Member Functions
	getLimitDropdown ()
	Gets a limit selection dropdown.

Additional Inherited Members
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)

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

Detailed Description

Table-based display with a user-selectable sort order.

Stability: stable: to extend

Definition at line 31 of file TablePager.php.

Constructor & Destructor Documentation

◆ __construct()

TablePager::__construct	(	IContextSource	$context = `null`,
		LinkRenderer	$linkRenderer = `null`
	)

Stability: stable: to call

Parameters

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

Reimplemented from IndexPager.

Definition at line 44 of file TablePager.php.

References ContextSource\$context, IndexPager\$linkRenderer, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, getDefaultSort(), getFieldNames(), ContextSource\getRequest(), isFieldSortable(), and ContextSource\setContext().

Member Function Documentation

◆ formatRow()

TablePager::formatRow ( $row )

Stability: stable: to override

Parameters

stdClass $row

Returns: string HTML

Reimplemented from IndexPager.

Reimplemented in AllMessagesTablePager.

Definition at line 196 of file TablePager.php.

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

◆ formatValue()

TablePager::formatValue	(	$name,
		$value
	)

abstract

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.

Parameters

string	$name	The database field name
string \| null	$value	The value retrieved from the database, or null if the row doesn't contain this field

Reimplemented in AllMessagesTablePager, ImageListPager, ProtectedPagesPager, and BlockListPager.

Referenced by formatRow().

◆ getBody()

TablePager::getBody ( )

final

Get the formatted result list.

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

Also adds the required styles to our OutputPage object (this means that if context wasn't passed to constructor or otherwise set up, you will get a pager with missing styles).

This method has been made 'final' in 1.24. There's no reason to override it, and if there exist any subclasses that do, the style loading hack is probably broken in them. Let's fail fast rather than mysteriously render things wrong.

Deprecated:: since 1.24, use getBodyOutput() or getFullOutput() instead

Returns: string

Reimplemented from IndexPager.

Definition at line 79 of file TablePager.php.

References getModuleStyles(), and ContextSource\getOutput().

◆ getBodyOutput()

TablePager::getBodyOutput ( )

Get the formatted result list.

Calls getBody() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky but works well.)

Since: 1.24

Returns: ParserOutput

Definition at line 93 of file TablePager.php.

References getModuleStyles(), and ParserOutput\setText().

◆ getCellAttrs()

TablePager::getCellAttrs	(	$field,
		$value
	)

protected

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

Stability: stable: to override

Parameters

string	$field	The column
string	$value	The cell contents

Returns: array Array of attr => value

Reimplemented in AllMessagesTablePager.

Definition at line 259 of file TablePager.php.

Referenced by formatRow().

◆ getCurrentRow()

TablePager::getCurrentRow ( )

protected

Returns: stdClass

Definition at line 244 of file TablePager.php.

References $mCurrentRow.

◆ getDefaultSort()

TablePager::getDefaultSort ( )

abstract

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 in AllMessagesTablePager, BlockListPager, ImageListPager, and ProtectedPagesPager.

Referenced by __construct().

◆ getEmptyBody()

TablePager::getEmptyBody ( )

protected

Returns: string

Reimplemented from IndexPager.

Definition at line 184 of file TablePager.php.

References getFieldNames(), and ContextSource\msg().

◆ getEndBody()

TablePager::getEndBody ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from IndexPager.

Reimplemented in AllMessagesTablePager.

Definition at line 177 of file TablePager.php.

◆ getFieldNames()

TablePager::getFieldNames ( )

abstractprotected

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 in AllMessagesTablePager, BlockListPager, ImageListPager, and ProtectedPagesPager.

Referenced by __construct(), formatRow(), getEmptyBody(), and getStartBody().

◆ getFullOutput()

TablePager::getFullOutput ( )

Get the formatted result list, with navigation bars.

Calls getBody(), getNavigationBar() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky but works well.)

Since: 1.24

Returns: ParserOutput

Definition at line 111 of file TablePager.php.

References getModuleStyles(), getNavigationBar(), and ParserOutput\setText().

Referenced by SpecialAutoblockList\showList(), and SpecialBlockList\showList().

◆ getHiddenFields()

TablePager::getHiddenFields ( $noResubmit = [] )

Get \<input type="hidden"\> elements for use in a method="get" form.

Resubmits all defined elements of the query string, except for a exclusion list, passed in the $noResubmit parameter.

Parameters

array $noResubmit Parameters from the request query which should not be resubmitted

Returns: string HTML fragment

Definition at line 407 of file TablePager.php.

References $s, and ContextSource\getRequest().

Referenced by getLimitDropdown().

◆ getIndexField()

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

Reimplemented from IndexPager.

Reimplemented in BlockListPager, ImageListPager, and ProtectedPagesPager.

Definition at line 267 of file TablePager.php.

References $mSort.

◆ getLimitDropdown()

TablePager::getLimitDropdown ( )

private

Gets a limit selection dropdown.

Returns: string

Definition at line 441 of file TablePager.php.

References getHiddenFields(), getLimitSelect(), and ContextSource\msg().

Referenced by getLimitForm().

◆ getLimitForm()

TablePager::getLimitForm ( )

Get a form containing a limit selection dropdown.

Returns: string HTML fragment

Definition at line 425 of file TablePager.php.

References getLimitDropdown(), and wfScript().

◆ getLimitSelect()

TablePager::getLimitSelect ( $attribs = [] )

Get a "<select>" element which has options for each of the allowed limits.

Parameters

string[] $attribs Extra attributes to set

Returns: string HTML fragment

Definition at line 359 of file TablePager.php.

References getLimitSelectList().

Referenced by getLimitDropdown().

◆ getLimitSelectList()

TablePager::getLimitSelectList ( )

Get a list of items to show in a "<select>" element of limits.

This can be passed directly to XmlSelect::addOptions().

Since: 1.22

Returns: array

Definition at line 375 of file TablePager.php.

References IndexPager\$mLimit, and ContextSource\getLanguage().

Referenced by getLimitSelect().

◆ getModuleStyles()

TablePager::getModuleStyles ( )

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

Stability: stable: to override

Since: 1.24

Returns: string[]

Definition at line 349 of file TablePager.php.

Referenced by getBody(), getBodyOutput(), and getFullOutput().

◆ getNavClass()

TablePager::getNavClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented in ImageListPager.

Definition at line 285 of file TablePager.php.

Referenced by getNavigationBar().

◆ getNavigationBar()

TablePager::getNavigationBar ( )

A navigation bar with images.

Stability: stable: to override

Returns: string HTML

Implements Pager.

Definition at line 303 of file TablePager.php.

References $title, $type, getNavClass(), ContextSource\getOutput(), IndexPager\getPagingQueries(), ContextSource\getTitle(), IndexPager\isNavigationBarShown(), and ContextSource\msg().

Referenced by getFullOutput().

◆ getRowAttrs()

TablePager::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 in AllMessagesTablePager.

Definition at line 237 of file TablePager.php.

References getRowClass().

Referenced by formatRow().

◆ getRowClass()

TablePager::getRowClass ( $row )

protected

Get a class name to be applied to the given row.

Stability: stable: to override

Parameters

stdClass $row The database result row

Returns: string

Definition at line 225 of file TablePager.php.

Referenced by getRowAttrs().

◆ getSortHeaderClass()

TablePager::getSortHeaderClass ( )

protected

Stability: stable: to override

Returns: string

Reimplemented in ImageListPager.

Definition at line 293 of file TablePager.php.

Referenced by getStartBody().

◆ getStartBody()

TablePager::getStartBody ( )

protected

Stability: stable: to override

Returns: string

Reimplemented from IndexPager.

Reimplemented in AllMessagesTablePager.

Definition at line 125 of file TablePager.php.

References IndexPager\$mLimit, $s, IndexPager\DIR_DESCENDING, getFieldNames(), getSortHeaderClass(), getTableClass(), isFieldSortable(), and IndexPager\makeLink().

◆ getTableClass()

TablePager::getTableClass ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented in BlockListPager, ImageListPager, and ProtectedPagesPager.

Definition at line 277 of file TablePager.php.

Referenced by getStartBody(), and AllMessagesTablePager\getStartBody().

◆ isFieldSortable()

TablePager::isFieldSortable ( $field )

abstractprotected

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

Parameters

string $field

Returns: bool

Reimplemented in ImageListPager, ProtectedPagesPager, BlockListPager, and AllMessagesTablePager.

Referenced by __construct(), and getStartBody().

Member Data Documentation

◆ $mCurrentRow

stdClass TablePager::$mCurrentRow

protected

Definition at line 36 of file TablePager.php.

Referenced by ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), and getCurrentRow().

◆ $mSort

string TablePager::$mSort

protected

Definition at line 33 of file TablePager.php.

Referenced by getIndexField().

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

includes/pager/TablePager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatRow()

◆ formatValue()

◆ getBody()

◆ getBodyOutput()

◆ getCellAttrs()

◆ getCurrentRow()

◆ getDefaultSort()

◆ getEmptyBody()

◆ getEndBody()

◆ getFieldNames()

◆ getFullOutput()

◆ getHiddenFields()

◆ getIndexField()

◆ getLimitDropdown()

◆ getLimitForm()

◆ getLimitSelect()

◆ getLimitSelectList()

◆ getModuleStyles()

◆ getNavClass()

◆ getNavigationBar()

◆ getRowAttrs()

◆ getRowClass()

◆ getSortHeaderClass()

◆ getStartBody()

◆ getTableClass()

◆ isFieldSortable()

Member Data Documentation

◆ $mCurrentRow

◆ $mSort