Pager for Special:Contributions. More...

Inheritance diagram for ContribsPager:

[legend]

Collaboration diagram for ContribsPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, array $options, LinkRenderer $linkRenderer=null, LinkBatchFactory $linkBatchFactory=null, HookContainer $hookContainer=null, ILoadBalancer $loadBalancer=null, ActorMigration $actorMigration=null, RevisionStore $revisionStore=null, NamespaceInfo $namespaceInfo=null, UserIdentity $targetUser=null)

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

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

	getIndexField ()

	getNamespace ()

	getNavigationBar ()
	Wrap the navigation bar in a p element with identifying class.

	getPreventClickjacking ()

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

	getTagFilter ()

	getTarget ()

	isNewOnly ()

	isQueryableRange ( $ipRange)
	Is the given IP a range and within the CIDR limit?

	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.

	tryCreatingRevisionRecord ( $row, $title=null)
	Check whether the revision associated is valid for formatting.

Public Member Functions inherited from RangeChronologicalPager
	getDateCond ( $year, $month, $day=-1)
	Takes ReverseChronologicalPager::getDateCond parameters and repurposes them to work with timestamp-based getDateRangeCond.

	getDateRangeCond ( $startStamp, $endStamp)
	Set and return a date range condition using timestamps provided by the user.

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)

Static Public Member Functions
static	processDateFilter (array $opts)
	Set up date filter options, given request data.

Static Public Member Functions inherited from ReverseChronologicalPager
static	getOffsetDate ( $year, $month, $day=-1)
	Core logic of determining the mOffset timestamp such that we can get all items with a timestamp up to the specified parameters.

Protected Member Functions
	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.

	getEndBody ()

	getExtraSortFields ()

	getNamespaceCond ()

	getSqlComment ()
	Overwrite Pager function and return a helpful comment.

	getStartBody ()

	preventClickjacking ()

Protected Member Functions inherited from RangeChronologicalPager
	buildQueryInfo ( $offset, $limit, $order)
	Build variables to use by the database wrapper.

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.

	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.

	getLimitLinks ()

	getLinkRenderer ()

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

	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.

Private Member Functions
	getIpRangeConds ( $db, $ip)
	Get SQL conditions for an IP range, if applicable.

	getTargetTable ()
	Return the table targeted for ordering and continuation.

Private Attributes
ActorMigration	$actorMigration

bool	$associated
	Set to true to show both the subject and talk namespace, no matter which got selected.

bool	$deletedOnly
	Set to true to show only deleted revisions.

bool	$hideMinor
	Set to true to hide edits marked as minor by the user.

HookRunner	$hookRunner

LinkBatchFactory	$linkBatchFactory

string[]	$messages
	Local cache for escaped messages.

array	$mParentLens

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

NamespaceInfo	$namespaceInfo

bool	$newOnly
	Set to true to show only new pages.

bool	$nsInvert
	Set to true to invert the namespace selection.

	$preventClickjacking = false

bool	$revisionsOnly
	Set to true to only include mediawiki revisions.

RevisionStore	$revisionStore

string false	$tagFilter
	Name of tag to filter, or false to ignore tags.

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

UserIdentity	$targetUser

TemplateParser	$templateParser

bool	$topOnly
	Set to true to show only latest (a.k.a.

Additional Inherited Members
Public Attributes inherited from ReverseChronologicalPager
int	$mDay

bool	$mDefaultDirection = IndexPager::DIR_DESCENDING

int	$mMonth

int	$mYear

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)

Protected Attributes inherited from RangeChronologicalPager
string[]	$rangeConds = []

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

Detailed Description

Pager for Special:Contributions.

Definition at line 41 of file ContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

ContribsPager::__construct	(	IContextSource	$context,
		array	$options,
		LinkRenderer	$linkRenderer = `null`,
		LinkBatchFactory	$linkBatchFactory = `null`,
		HookContainer	$hookContainer = `null`,
		ILoadBalancer	$loadBalancer = `null`,
		ActorMigration	$actorMigration = `null`,
		RevisionStore	$revisionStore = `null`,
		NamespaceInfo	$namespaceInfo = `null`,
		UserIdentity	$targetUser = `null`
	)

Parameters

IContextSource	$context
array	$options
LinkRenderer \| null	$linkRenderer
LinkBatchFactory \| null	$linkBatchFactory
HookContainer \| null	$hookContainer
ILoadBalancer \| null	$loadBalancer
ActorMigration \| null	$actorMigration
RevisionStore \| null	$revisionStore
NamespaceInfo \| null	$namespaceInfo
UserIdentity \| null	$targetUser

Definition at line 142 of file ContribsPager.php.

References IndexPager\$linkRenderer, RangeChronologicalPager\getDateRangeCond(), MediaWiki\User\UserIdentity\getName(), and ContextSource\msg().

Member Function Documentation

◆ doBatchLookups()

ContribsPager::doBatchLookups ( )

protected

Called from getBody(), before getStartBody() is called and after doQuery() was called.

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

Stability: stable: to override

Returns: void

Reimplemented from IndexPager.

Definition at line 566 of file ContribsPager.php.

References NS_USER_TALK.

◆ formatRow()

ContribsPager::formatRow ( $row )

Generates each row in the contributions list.

Contributions which are marked "top" are currently on top of the history. For these contributions, a [rollback] link is shown for users with roll- back 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 | mixed $row

Returns: string

Reimplemented from IndexPager.

Definition at line 642 of file ContribsPager.php.

References $lang, Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), getContext(), Linker\getRevDeleteLink(), Linker\revComment(), Linker\userLink(), Linker\userTalkLink(), and wfDebug().

◆ getDefaultQuery()

ContribsPager::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 230 of file ContribsPager.php.

◆ getEndBody()

ContribsPager::getEndBody ( )

protected

Returns: string

Reimplemented from IndexPager.

Definition at line 605 of file ContribsPager.php.

◆ getExtraSortFields()

ContribsPager::getExtraSortFields ( )

protected

Returns: string[]

Reimplemented from IndexPager.

Definition at line 545 of file ContribsPager.php.

References wfWarn().

◆ getIndexField()

ContribsPager::getIndexField ( )

Returns: string

Reimplemented from IndexPager.

Definition at line 493 of file ContribsPager.php.

References wfWarn().

Referenced by reallyDoQuery().

◆ getIpRangeConds()

ContribsPager::getIpRangeConds	(	$db,
		$ip
	)

private

Get SQL conditions for an IP range, if applicable.

Parameters

IDatabase	$db
string	$ip	The IP address or CIDR

Returns: string|false SQL for valid IP ranges, false if invalid

Definition at line 457 of file ContribsPager.php.

◆ getNamespace()

ContribsPager::getNamespace ( )

Returns: int|string

Definition at line 538 of file ContribsPager.php.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )

protected

Definition at line 428 of file ContribsPager.php.

References $dbr.

◆ getNavigationBar()

ContribsPager::getNavigationBar ( )

Wrap the navigation bar in a p element with identifying class.

In future we may want to change the p tag to a div and upstream this to the parent class.

Returns: string HTML

Reimplemented from ReverseChronologicalPager.

Definition at line 244 of file ContribsPager.php.

Referenced by SpecialContributions\execute().

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )

Returns: bool

Definition at line 856 of file ContribsPager.php.

Referenced by SpecialContributions\execute().

◆ getQueryInfo()

ContribsPager::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 349 of file ContribsPager.php.

References $dbr, $revQuery, getAuthority(), and ChangeTags\modifyDisplayQuery().

◆ getSqlComment()

ContribsPager::getSqlComment ( )

protected

Overwrite Pager function and return a helpful comment.

Returns: string

Reimplemented from IndexPager.

Definition at line 840 of file ContribsPager.php.

◆ getStartBody()

ContribsPager::getStartBody ( )

protected

Returns: string

Reimplemented from IndexPager.

Definition at line 598 of file ContribsPager.php.

◆ getTagFilter()

ContribsPager::getTagFilter ( )

Returns: false|string

Definition at line 517 of file ContribsPager.php.

◆ getTarget()

ContribsPager::getTarget ( )

Returns: string

Definition at line 524 of file ContribsPager.php.

◆ getTargetTable()

ContribsPager::getTargetTable ( )

private

Return the table targeted for ordering and continuation.

See T200259 and T221380.

Warning: Keep this in sync with self::getQueryInfo()!

Returns: string

Definition at line 333 of file ContribsPager.php.

References $dbr.

◆ isNewOnly()

ContribsPager::isNewOnly ( )

Returns: bool

Definition at line 531 of file ContribsPager.php.

◆ isQueryableRange()

ContribsPager::isQueryableRange ( $ipRange )

Is the given IP a range and within the CIDR limit?

Parameters

string $ipRange

Returns: bool True if it is valid

Since: 1.30

Definition at line 475 of file ContribsPager.php.

Referenced by SpecialContributions\execute().

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )

protected

Definition at line 849 of file ContribsPager.php.

◆ processDateFilter()

static ContribsPager::processDateFilter ( array $opts )

static

Set up date filter options, given request data.

Parameters

array $opts Options array

Returns: array Options array with processed start and end date filter options

Definition at line 866 of file ContribsPager.php.

References ReverseChronologicalPager\getOffsetDate().

◆ reallyDoQuery()

ContribsPager::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 259 of file ContribsPager.php.

References $dbr, RangeChronologicalPager\buildQueryInfo(), ContextSource\getConfig(), IndexPager\getDatabase(), and getIndexField().

◆ tryCreatingRevisionRecord()

ContribsPager::tryCreatingRevisionRecord	(	$row,
		$title = `null`
	)

Check whether the revision associated is valid for formatting.

If has no associated revision ID then null is returned.

This was previously used by formatRow() but now exists only for the convenience of extensions.

Since: 1.35

Deprecated:: since 1.37 use RevisionStore::isRevisionRow()

Parameters

stdClass	$row
Title \| null	$title

Returns: RevisionRecord|null

Definition at line 623 of file ContribsPager.php.

References $title.

Member Data Documentation

◆ $actorMigration

ActorMigration ContribsPager::$actorMigration

private

Definition at line 122 of file ContribsPager.php.

◆ $associated

bool ContribsPager::$associated

private

Set to true to show both the subject and talk namespace, no matter which got selected.

Definition at line 72 of file ContribsPager.php.

◆ $deletedOnly

bool ContribsPager::$deletedOnly

private

Set to true to show only deleted revisions.

Definition at line 77 of file ContribsPager.php.

◆ $hideMinor

bool ContribsPager::$hideMinor

private

Set to true to hide edits marked as minor by the user.

Definition at line 92 of file ContribsPager.php.

◆ $hookRunner

HookRunner ContribsPager::$hookRunner

private

Definition at line 119 of file ContribsPager.php.

◆ $linkBatchFactory

LinkBatchFactory ContribsPager::$linkBatchFactory

private

Definition at line 116 of file ContribsPager.php.

◆ $messages

string [] ContribsPager::$messages

private

Local cache for escaped messages.

Definition at line 46 of file ContribsPager.php.

◆ $mParentLens

array ContribsPager::$mParentLens

private

Definition at line 105 of file ContribsPager.php.

◆ $namespace

string int ContribsPager::$namespace

private

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

Definition at line 56 of file ContribsPager.php.

◆ $namespaceInfo

NamespaceInfo ContribsPager::$namespaceInfo

private

Definition at line 128 of file ContribsPager.php.

◆ $newOnly

bool ContribsPager::$newOnly

private

Set to true to show only new pages.

Definition at line 87 of file ContribsPager.php.

◆ $nsInvert

bool ContribsPager::$nsInvert

private

Set to true to invert the namespace selection.

Definition at line 66 of file ContribsPager.php.

◆ $preventClickjacking

ContribsPager::$preventClickjacking = false

private

Definition at line 100 of file ContribsPager.php.

◆ $revisionsOnly

bool ContribsPager::$revisionsOnly

private

Set to true to only include mediawiki revisions.

(restricts extensions from executing additional queries to include their own contributions)

Definition at line 98 of file ContribsPager.php.

◆ $revisionStore

RevisionStore ContribsPager::$revisionStore

private

Definition at line 125 of file ContribsPager.php.

◆ $tagFilter

string false ContribsPager::$tagFilter

private

Name of tag to filter, or false to ignore tags.

Definition at line 61 of file ContribsPager.php.

◆ $target

string ContribsPager::$target

private

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

Definition at line 51 of file ContribsPager.php.

◆ $targetUser

UserIdentity ContribsPager::$targetUser

private

Definition at line 108 of file ContribsPager.php.

◆ $templateParser

TemplateParser ContribsPager::$templateParser

private

Definition at line 113 of file ContribsPager.php.

◆ $topOnly

bool ContribsPager::$topOnly

private

Set to true to show only latest (a.k.a.

current) revisions

Definition at line 82 of file ContribsPager.php.

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

includes/specials/pagers/ContribsPager.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doBatchLookups()

◆ formatRow()

◆ getDefaultQuery()

◆ getEndBody()

◆ getExtraSortFields()

◆ getIndexField()

◆ getIpRangeConds()

◆ getNamespace()

◆ getNamespaceCond()

◆ getNavigationBar()

◆ getPreventClickjacking()

◆ getQueryInfo()

◆ getSqlComment()

◆ getStartBody()

◆ getTagFilter()

◆ getTarget()

◆ getTargetTable()

◆ isNewOnly()

◆ isQueryableRange()

◆ preventClickjacking()

◆ processDateFilter()

◆ reallyDoQuery()

◆ tryCreatingRevisionRecord()

Member Data Documentation

◆ $actorMigration

◆ $associated

◆ $deletedOnly

◆ $hideMinor

◆ $hookRunner

◆ $linkBatchFactory

◆ $messages

◆ $mParentLens

◆ $namespace

◆ $namespaceInfo

◆ $newOnly

◆ $nsInvert

◆ $preventClickjacking

◆ $revisionsOnly

◆ $revisionStore

◆ $tagFilter

◆ $target

◆ $targetUser

◆ $templateParser

◆ $topOnly