Inheritance diagram for DeletedContribsPager:

[legend]

Collaboration diagram for DeletedContribsPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, $target, $namespace, LinkRenderer $linkRenderer, HookContainer $hookContainer, ILoadBalancer $loadBalancer, CommentStore $commentStore, RevisionFactory $revisionFactory)

	formatRow ( $row)
	Generates each row in the contributions list.

	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.

	getIndexField ()
	Returns the name of the index field.

	getNamespace ()

	getNavigationBar ()

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

	getTarget ()

	reallyDoQuery ( $offset, $limit, $order)
	This method basically executes the exact same code as the parent class, though with a hook added, to allow extensions to add additional queries.

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

	doQuery ()
	Do the query, using information from the object context.

	getBody ()
	Get the formatted result list.

	getDatabase ()
	Get the Database object in use.

	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.

	getResult ()

	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)

Public Attributes
bool	$mDefaultDirection = IndexPager::DIR_DESCENDING
	Default direction for pager.

string[]	$messages
	Local cache for escaped messages.

string int	$namespace = ''
	A single namespace number, or an empty string for all namespaces.

string	$target
	User name, or a string describing an IP address range.

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
	getEndBody ()
	Hook into getBody() for the end of the list.

	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start.

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.

	getEmptyBody ()
	Hook into getBody(), for the bit between the start and the end when there are no rows.

	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
string	$mNavigationBar
	Navigation bar with paging links.

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
	formatRevisionRow ( $row)
	Generates each row in the contributions list for archive entries.

	getNamespaceCond ()

Private Attributes
CommentStore	$commentStore

HookRunner	$hookRunner

RevisionFactory	$revisionFactory

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

Detailed Description

Definition at line 34 of file DeletedContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

DeletedContribsPager::__construct	(	IContextSource	$context,
			$target,
			$namespace,
		LinkRenderer	$linkRenderer,
		HookContainer	$hookContainer,
		ILoadBalancer	$loadBalancer,
		CommentStore	$commentStore,
		RevisionFactory	$revisionFactory
	)

Parameters

IContextSource	$context
string	$target
string \| int	$namespace
LinkRenderer	$linkRenderer
HookContainer	$hookContainer
ILoadBalancer	$loadBalancer
CommentStore	$commentStore
RevisionFactory	$revisionFactory

Definition at line 80 of file DeletedContribsPager.php.

References Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), and ContextSource\msg().

Member Function Documentation

◆ formatRevisionRow()

DeletedContribsPager::formatRevisionRow ( $row )

private

Generates each row in the contributions list for archive entries.

Contributions which are marked "top" are currently on top of the history. For these contributions, a [rollback] link is shown for users with sysop privileges. The rollback link restores the most recent version that was not written by the target user.

Todo:: This would probably look a lot nicer in a table.

Parameters

stdClass $row

Returns: string

Definition at line 301 of file DeletedContribsPager.php.

References getAuthority(), Linker\getRevDeleteLink(), Linker\getRevisionDeletedClass(), SpecialPage\getTitleFor(), and Linker\revComment().

◆ formatRow()

DeletedContribsPager::formatRow ( $row )

Generates each row in the contributions list.

Todo:: This would probably look a lot nicer in a table.

Parameters

stdClass $row

Returns: string

Reimplemented from IndexPager.

Definition at line 253 of file DeletedContribsPager.php.

References wfDebug().

◆ getDefaultQuery()

DeletedContribsPager::getDefaultQuery ( )

Get an array of query parameters that should be put into self-links.

By default, all parameters passed in the URL are used, apart from a few exceptions.

Stability: stable: to override

Returns: array Associative array

Reimplemented from IndexPager.

Definition at line 104 of file DeletedContribsPager.php.

◆ getEndBody()

DeletedContribsPager::getEndBody ( )

protected

Hook into getBody() for the end of the list.

Stability: stable: to override

Returns: string

Reimplemented from IndexPager.

Definition at line 199 of file DeletedContribsPager.php.

◆ getIndexField()

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

Reimplemented from IndexPager.

Definition at line 177 of file DeletedContribsPager.php.

Referenced by reallyDoQuery().

◆ getNamespace()

DeletedContribsPager::getNamespace ( )

Returns: int|string

Definition at line 191 of file DeletedContribsPager.php.

◆ getNamespaceCond()

DeletedContribsPager::getNamespaceCond ( )

private

Definition at line 238 of file DeletedContribsPager.php.

Referenced by getQueryInfo().

◆ getNavigationBar()

DeletedContribsPager::getNavigationBar ( )

Implements Pager.

Definition at line 203 of file DeletedContribsPager.php.

References $lang.

◆ getQueryInfo()

DeletedContribsPager::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 IndexPager.

Definition at line 111 of file DeletedContribsPager.php.

References $dbr, getAuthority(), IndexPager\getDatabase(), and getNamespaceCond().

◆ getStartBody()

DeletedContribsPager::getStartBody ( )

protected

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Returns: string

Reimplemented from IndexPager.

Definition at line 195 of file DeletedContribsPager.php.

◆ getTarget()

DeletedContribsPager::getTarget ( )

Returns: string

Definition at line 184 of file DeletedContribsPager.php.

◆ reallyDoQuery()

DeletedContribsPager::reallyDoQuery	(	$offset,
		$limit,
		$order
	)

This method basically executes the exact same code as the parent class, though with a hook added, to allow extensions to add additional queries.

Parameters

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

Returns: IResultWrapper

Reimplemented from IndexPager.

Definition at line 143 of file DeletedContribsPager.php.

References getIndexField().

Member Data Documentation

◆ $commentStore

CommentStore DeletedContribsPager::$commentStore

private

Definition at line 65 of file DeletedContribsPager.php.

◆ $hookRunner

HookRunner DeletedContribsPager::$hookRunner

private

Definition at line 62 of file DeletedContribsPager.php.

◆ $mDefaultDirection

bool DeletedContribsPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Default direction for pager.

Definition at line 39 of file DeletedContribsPager.php.

◆ $messages

string [] DeletedContribsPager::$messages

Local cache for escaped messages.

Definition at line 44 of file DeletedContribsPager.php.

◆ $mNavigationBar

string DeletedContribsPager::$mNavigationBar

protected

Navigation bar with paging links.

Definition at line 59 of file DeletedContribsPager.php.

◆ $namespace

string int DeletedContribsPager::$namespace = ''

A single namespace number, or an empty string for all namespaces.

Definition at line 54 of file DeletedContribsPager.php.

◆ $revisionFactory

RevisionFactory DeletedContribsPager::$revisionFactory

private

Definition at line 68 of file DeletedContribsPager.php.

◆ $target

string DeletedContribsPager::$target

User name, or a string describing an IP address range.

Definition at line 49 of file DeletedContribsPager.php.

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

includes/specials/pagers/DeletedContribsPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatRevisionRow()

◆ formatRow()

◆ getDefaultQuery()

◆ getEndBody()

◆ getIndexField()

◆ getNamespace()

◆ getNamespaceCond()

◆ getNavigationBar()

◆ getQueryInfo()

◆ getStartBody()

◆ getTarget()

◆ reallyDoQuery()

Member Data Documentation

◆ $commentStore

◆ $hookRunner

◆ $mDefaultDirection

◆ $messages

◆ $mNavigationBar

◆ $namespace

◆ $revisionFactory

◆ $target