Inherits MediaWiki\Pager\CodexTablePager.

Collaboration diagram for MediaWiki\Specials\Pager\EditWatchlistPager:

[legend]

Public Member Functions

__construct (IContextSource $context, protected Title $title, protected WatchedItemStoreInterface $wis, protected NamespaceInfo $namespaceInfo, protected LinkBatchFactory $linkBatchFactory, protected HookRunner $hookRunner, protected bool $expiryEnabled)

formatRow ( $row)

Stability: stable: to override

Parameters

stdClass $row

Returns: string HTML

formatValue ( $name, $value, ?Title $title=null)

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

getEmptyBody ()

Get markup for the "no results" UI.This is placed inside the tbody tag.

getEndBody ()

Get the closing tbody tag through the closing table tag.

Stability: stable: to override

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

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

getOrderedResult ()

Prune and re-sort the results.

getQueryInfo ()

Not used because we override reallyDoQuery(), but parent insists that it is implemented.

getStartBody ()

Wrap the table in a form tag and add action buttons in header.

getTitle ()

isFieldSortable ( $field)

Because of the way the db is indexed none of the fields are sortable via the UI, so always return false.

isNavigationBarShown ()

Returns whether to show the "navigation bar".

reallyDoQuery ( $offset, $limit, $order)

Do a query with specified parameters, rather than using the object context.

Note: For b/c, query direction is true for ascending and false for descending

Stability: stable: to override

Parameters

string	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: IResultWrapper

Public Member Functions inherited from MediaWiki\Pager\CodexTablePager

__construct (string $caption, ?IContextSource $context=null, ?LinkRenderer $linkRenderer=null)

getFullOutput ()

Get the entire Codex table markup, including the wrapper element, pagers, table wrapper (which enables horizontal scroll), and the table element.

getLimitSelect (array $attribs=[])

Get a <select> element with options for items-per-page limits.

getLimitSelectList ()

Get a list of items to show as options in the item-per-page select.

getModuleStyles ()

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

Stability: stable: to override

Since: 1.38

Returns: string[]

getNavigationBar ()

Pager bar with per-page limit and pager buttons.

getNavigationBuilder ()

Public Member Functions inherited from MediaWiki\Pager\TablePager

__construct (?IContextSource $context=null, ?LinkRenderer $linkRenderer=null)

formatValue ( $name, $value)

Format a table cell.

getBodyOutput ()

Get the formatted result list.

getHiddenFields ( $noResubmit=[])

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

getLimitForm ()

Get a form containing a limit selection dropdown.

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.

getNumRows ()

Get the number of rows in the result set.

getOffset ()

getOffsetQuery ()

Get the current offset for the URL query parameter.

getPagingQueries ()

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

getQueryOrder ()

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)

Protected Member Functions
	createNavigationBuilder ()
	Create a new navigation builder instance.Subclasses can override this method to provide a custom navigation builder, such as CodexPagerNavigationBuilder for Codex-styled navigation. Stability: stable to override Since 1.46 Returns PagerNavigationBuilder

	getCheckbox (string $name, string $id, string $value, array $class)
	Get a Codex-structured HTML checkbox.

	getHeader ()

	getThead ()
	Create custom table header with action buttons.

Protected Member Functions inherited from MediaWiki\Pager\CodexTablePager
	getCellAlignment (string $field)
	Add alignment per column.

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

	getNavClass ()
	Class for the outermost element of the pager UI.

	getSortHeaderClass ()
	Class for th elements of sortable columns.

	getTableClass ()
	Class for the `<table>` element.

	getTfoot ()
	Override to add a `<tfoot>` element.

	shouldShowVisibleCaption ()
	Returns whether a visible table caption should be shown.

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

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

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

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

	getOffsetCondsAndSortOptions ( $offset, int $limit, bool $order)
	Get $conds and $options relevant for sorting.

	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.

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

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

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)

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

Protected Attributes inherited from MediaWiki\Pager\CodexTablePager
string	$mCaption

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

string	$mSort

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

PagerNavigationBuilder	$navigationBuilder = null

Detailed Description

Definition at line 34 of file EditWatchlistPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\Pager\EditWatchlistPager::__construct	(	IContextSource	$context,
		protected Title	$title,
		protected WatchedItemStoreInterface	$wis,
		protected NamespaceInfo	$namespaceInfo,
		protected LinkBatchFactory	$linkBatchFactory,
		protected HookRunner	$hookRunner,
		protected bool	$expiryEnabled )

Parameters

IContextSource	$context
Title	$title
WatchedItemStoreInterface	$wis
NamespaceInfo	$namespaceInfo
LinkBatchFactory	$linkBatchFactory
HookRunner	$hookRunner
bool	$expiryEnabled

Definition at line 46 of file EditWatchlistPager.php.

References MediaWiki\Context\ContextSource\msg().

Member Function Documentation

◆ createNavigationBuilder()

MediaWiki\Specials\Pager\EditWatchlistPager::createNavigationBuilder ( )

protected

Create a new navigation builder instance.Subclasses can override this method to provide a custom navigation builder, such as CodexPagerNavigationBuilder for Codex-styled navigation.

Stability: stable: to override

Since: 1.46

Returns: PagerNavigationBuilder

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 54 of file EditWatchlistPager.php.

◆ formatRow()

MediaWiki\Specials\Pager\EditWatchlistPager::formatRow ( $row )

Stability: stable: to override

Parameters

stdClass $row

Returns: string HTML

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 416 of file EditWatchlistPager.php.

◆ formatValue()

MediaWiki\Specials\Pager\EditWatchlistPager::formatValue	(		$name,
			$value,
		?Title	$title = null )

Definition at line 448 of file EditWatchlistPager.php.

◆ getCheckbox()

MediaWiki\Specials\Pager\EditWatchlistPager::getCheckbox	(	string	$name,
		string	$id,
		string	$value,
		array	$class )

protected

Get a Codex-structured HTML checkbox.

Parameters

string	$name
string	$id
string	$value
array	$class

Returns: string HTML of the checkbox wrapper.

Definition at line 308 of file EditWatchlistPager.php.

◆ getDefaultSort()

MediaWiki\Specials\Pager\EditWatchlistPager::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 69 of file EditWatchlistPager.php.

◆ getEmptyBody()

MediaWiki\Specials\Pager\EditWatchlistPager::getEmptyBody ( )

Get markup for the "no results" UI.This is placed inside the tbody tag.

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 380 of file EditWatchlistPager.php.

◆ getEndBody()

MediaWiki\Specials\Pager\EditWatchlistPager::getEndBody ( )

Get the closing tbody tag through the closing table tag.

Stability: stable: to override

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 363 of file EditWatchlistPager.php.

◆ getFieldNames()

MediaWiki\Specials\Pager\EditWatchlistPager::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: string[]

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 398 of file EditWatchlistPager.php.

◆ getHeader()

MediaWiki\Specials\Pager\EditWatchlistPager::getHeader ( )

protected

Returns: string

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 330 of file EditWatchlistPager.php.

◆ getIndexField()

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

Definition at line 96 of file EditWatchlistPager.php.

◆ getOrderedResult()

MediaWiki\Specials\Pager\EditWatchlistPager::getOrderedResult ( )

Prune and re-sort the results.

Returns: IResultWrapper

Definition at line 180 of file EditWatchlistPager.php.

◆ getQueryInfo()

MediaWiki\Specials\Pager\EditWatchlistPager::getQueryInfo ( )

Not used because we override reallyDoQuery(), but parent insists that it is implemented.

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 89 of file EditWatchlistPager.php.

◆ getStartBody()

MediaWiki\Specials\Pager\EditWatchlistPager::getStartBody ( )

Wrap the table in a form tag and add action buttons in header.

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 232 of file EditWatchlistPager.php.

◆ getThead()

MediaWiki\Specials\Pager\EditWatchlistPager::getThead ( )

protected

Create custom table header with action buttons.

Reimplemented from MediaWiki\Pager\CodexTablePager.

Definition at line 268 of file EditWatchlistPager.php.

◆ getTitle()

MediaWiki\Specials\Pager\EditWatchlistPager::getTitle ( )

Since: 1.18

Stability: stable: to override

Returns: Title|null

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 58 of file EditWatchlistPager.php.

◆ isFieldSortable()

MediaWiki\Specials\Pager\EditWatchlistPager::isFieldSortable ( $field )

Because of the way the db is indexed none of the fields are sortable via the UI, so always return false.

Parameters

string $field

Returns: false

Reimplemented from MediaWiki\Pager\TablePager.

Definition at line 80 of file EditWatchlistPager.php.

◆ isNavigationBarShown()

MediaWiki\Specials\Pager\EditWatchlistPager::isNavigationBarShown ( )

Returns whether to show the "navigation bar".

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 62 of file EditWatchlistPager.php.

◆ reallyDoQuery()

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

Do a query with specified parameters, rather than using the object context.

Note: For b/c, query direction is true for ascending and false for descending

Stability: stable: to override

Parameters

string	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: IResultWrapper

Parameters

string	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: ResultWrapper

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 118 of file EditWatchlistPager.php.

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

includes/Specials/Pager/EditWatchlistPager.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNavigationBuilder()

◆ formatRow()

◆ formatValue()

◆ getCheckbox()

◆ getDefaultSort()

◆ getEmptyBody()

◆ getEndBody()

◆ getFieldNames()

◆ getHeader()

◆ getIndexField()

◆ getOrderedResult()

◆ getQueryInfo()

◆ getStartBody()

◆ getThead()

◆ getTitle()

◆ isFieldSortable()

◆ isNavigationBarShown()

◆ reallyDoQuery()