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, CommentFormatter $commentFormatter=null)
	FIXME List services first T266484 / T290405.

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

	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)
	If the object looks like a revision row, or corresponds to a previously cached revision, return the RevisionRecord.

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

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.

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

	getNavigationBuilder ()

	getNumRows ()
	Get the number of rows in the result set.

	getOffsetQuery ()
	Get the current offset for the URL query parameter.

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

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

	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.

Public Attributes
	$mGroupByDate = true

Public Attributes inherited from ReverseChronologicalPager
int	$mDay

bool	$mDefaultDirection = IndexPager::DIR_DESCENDING

bool	$mGroupByDate = false
	Whether to group items by date.

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)

Protected Member Functions

doBatchLookups ()

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

getEndBody ()

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

Stability: stable: to override

Returns: string

getExtraSortFields ()

getNamespaceCond ()

getSqlComment ()

Overwrite Pager function and return a helpful comment.

getStartBody ()

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

preventClickjacking ()

setPreventClickjacking (bool $enable)

Protected Member Functions inherited from RangeChronologicalPager

buildQueryInfo ( $offset, $limit, $order)

Build variables to use by the database wrapper.

Protected Member Functions inherited from ReverseChronologicalPager

getDateFromTimestamp (string $timestamp)

Get date from the timestamp.

getEndGroup ()

End an existing group of page rows.

getFooter ()

Classes can extend to output a footer at the bottom of the pager list.

Since: 1.38

Returns: string

getHeaderRow (string $date)

getRow ( $row)

Get the HTML of a pager row.

Stability: stable: to override

Since: 1.38

Parameters

stdClass $row

Returns: string

getStartGroup ()

Start a new group of page rows.

isFirstHeaderRow ()

Determines whether the header row is the first that will be outputted to the page.

isHeaderRowNeeded (string $date)

Determines if a header row is needed based on the current state of the IndexPager.

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.

Additional Inherited Members
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 43 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,
		CommentFormatter	$commentFormatter = null )

FIXME List services first T266484 / T290405.

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
CommentFormatter \| null	$commentFormatter

Definition at line 157 of file ContribsPager.php.

References 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 getAuthority(), and 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 656 of file ContribsPager.php.

References $lang, Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), getAuthority(), getContext(), Linker\getRevDeleteLink(), 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 248 of file ContribsPager.php.

◆ getEndBody()

ContribsPager::getEndBody ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from IndexPager.

Definition at line 618 of file ContribsPager.php.

◆ getExtraSortFields()

ContribsPager::getExtraSortFields ( )

protected

Returns: string[]

Reimplemented from IndexPager.

Definition at line 547 of file ContribsPager.php.

References wfWarn().

◆ getIndexField()

ContribsPager::getIndexField ( )

Returns: string

Reimplemented from IndexPager.

Definition at line 497 of file ContribsPager.php.

References wfWarn().

Referenced by reallyDoQuery().

◆ getNamespace()

ContribsPager::getNamespace ( )

Returns: int|string

Definition at line 540 of file ContribsPager.php.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )

protected

Definition at line 432 of file ContribsPager.php.

References $dbr.

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )

Returns: bool

Definition at line 897 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 350 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 870 of file ContribsPager.php.

◆ getStartBody()

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

◆ getTagFilter()

ContribsPager::getTagFilter ( )

Returns: false|string[]

Definition at line 519 of file ContribsPager.php.

◆ getTarget()

ContribsPager::getTarget ( )

Returns: string

Definition at line 526 of file ContribsPager.php.

◆ isNewOnly()

ContribsPager::isNewOnly ( )

Returns: bool

Definition at line 533 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 479 of file ContribsPager.php.

Referenced by SpecialContributions\execute().

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )

protected

Deprecated: since 1.38, use ::setPreventClickjacking() instead

Definition at line 882 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 907 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 264 of file ContribsPager.php.

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

◆ setPreventClickjacking()

ContribsPager::setPreventClickjacking ( bool $enable )

protected

Parameters

bool $enable

Since: 1.38

Definition at line 890 of file ContribsPager.php.

◆ tryCreatingRevisionRecord()

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

If the object looks like a revision row, or corresponds to a previously cached revision, return the RevisionRecord.

Otherwise, return null.

Since: 1.35

Parameters

mixed	$row
Title \| null	$title

Returns: RevisionRecord|null

Definition at line 632 of file ContribsPager.php.

References $title.

Member Data Documentation

◆ $mGroupByDate

ContribsPager::$mGroupByDate = true

Definition at line 45 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

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doBatchLookups()

◆ formatRow()

◆ getDefaultQuery()

◆ getEndBody()

◆ getExtraSortFields()

◆ getIndexField()

◆ getNamespace()

◆ getNamespaceCond()

◆ getPreventClickjacking()

◆ getQueryInfo()

◆ getSqlComment()

◆ getStartBody()

◆ getTagFilter()

◆ getTarget()

◆ isNewOnly()

◆ isQueryableRange()

◆ preventClickjacking()

◆ processDateFilter()

◆ reallyDoQuery()

◆ setPreventClickjacking()

◆ tryCreatingRevisionRecord()

Member Data Documentation

◆ $mGroupByDate