Inheritance diagram for ContribsPager:

[legend]

Collaboration diagram for ContribsPager:

[legend]

Public Member Functions
	__construct (IContextSource $context, array $options)

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

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

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

	getEndBody ()

	getIndexField ()
	Override of getIndexField() in IndexPager.

	getNamespaceCond ()

	getPreventClickjacking ()

	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.

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

	getStartBody ()

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

	reallyDoQuery ( $offset, $limit, $descending)
	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 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)

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

	extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this.

	getBody ()
	Get the formatted result list.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

	getLimitLinks ()

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

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

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

	getResult ()

	isNavigationBarShown ()
	Returns whether to show the "navigation bar".

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

	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.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key)
	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
	$mDb

IDatabase	$mDbSecondary

	$mDefaultDirection = IndexPager::DIR_DESCENDING

	$messages

	$namespace = ''

	$preventClickjacking = false

	$target

Public Attributes inherited from ReverseChronologicalPager
	$mDay

	$mDefaultDirection = IndexPager::DIR_DESCENDING

	$mMonth

	$mYear

Public Attributes inherited from IndexPager
	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

	$mDefaultLimit = 50

	$mIsBackwards

	$mIsFirst
	True if the current result set is the first one.

	$mIsLast

	$mLimit

	$mLimitsShown = [ 20, 50, 100, 250, 500 ]

	$mOffset

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

IResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Constants for the $mDefaultDirection field.

const	DIR_DESCENDING = true

Protected Member Functions
	preventClickjacking ()

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

Protected Member Functions inherited from IndexPager
	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 ()
	This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField().

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

Protected Attributes
array	$mParentLens

TemplateParser	$templateParser

Protected Attributes inherited from RangeChronologicalPager
	$rangeConds = []

Protected Attributes inherited from IndexPager
	$mDefaultQuery

	$mExtraSortFields
	An array of secondary columns to order by.

	$mFirstShown

	$mIncludeOffset = false
	Whether to include the offset in the query.

	$mIndexField
	The index to actually be used for ordering.

	$mLastShown

	$mNavigationBar

	$mOrderType
	For pages that support multiple types of ordering, which one to use.

	$mPastTheEndIndex

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

Detailed Description

Definition at line 31 of file ContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

ContribsPager::__construct	(	IContextSource	$context,
		array	$options )

Definition at line 53 of file ContribsPager.php.

References $context, $options, DB_REPLICA, RangeChronologicalPager\getDateRangeCond(), getIndexField(), ContextSource\msg(), and wfGetDB().

Member Function Documentation

◆ doBatchLookups()

ContribsPager::doBatchLookups ( )

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.

Returns: void

Reimplemented from IndexPager.

Definition at line 362 of file ContribsPager.php.

References $batch, 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

object $row

Returns: string

Reimplemented from IndexPager.

Definition at line 421 of file ContribsPager.php.

References $attribs, $e, $lang, $link, $linkRenderer, $ret, $rev, ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), getContext(), Linker\getRevDeleteLink(), list, Linker\revComment(), ChangesList\showCharacterDifference(), Linker\userLink(), Linker\userTalkLink(), wfArrayFilterByKey(), 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, except for a short blacklist.

Returns: array Associative array

Reimplemented from IndexPager.

Definition at line 102 of file ContribsPager.php.

References $query, and $target.

◆ getEndBody()

ContribsPager::getEndBody ( )

Returns: string

Reimplemented from IndexPager.

Definition at line 405 of file ContribsPager.php.

◆ getIndexField()

ContribsPager::getIndexField ( )

Override of getIndexField() in IndexPager.

For IP ranges, it's faster to use the replicated ipc_rev_timestamp on the ip_changes table than the rev_timestamp on the revision table.

Returns: string Name of field

Reimplemented from IndexPager.

Definition at line 354 of file ContribsPager.php.

Referenced by __construct(), and 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 315 of file ContribsPager.php.

References list.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )

Definition at line 285 of file ContribsPager.php.

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )

Returns: bool

Definition at line 632 of file ContribsPager.php.

◆ getQueryInfo()

ContribsPager::getQueryInfo ( )

This function should be overridden to provide 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 177 of file ContribsPager.php.

References $revQuery, User\getGroupsWithPermission(), ChangeTags\modifyDisplayQuery(), User\newFromName(), and wfTimestamp().

◆ getSqlComment()

ContribsPager::getSqlComment ( )

Overwrite Pager function and return a helpful comment.

Returns: string

Reimplemented from IndexPager.

Definition at line 616 of file ContribsPager.php.

◆ getStartBody()

ContribsPager::getStartBody ( )

Returns: string

Reimplemented from IndexPager.

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

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )

protected

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

References ReverseChronologicalPager\getOffsetDate().

Referenced by SpecialContributions\execute(), ApiFeedContributions\execute(), and ContribsPagerTest\testDateFilterOptionProcessing().

◆ reallyDoQuery()

ContribsPager::reallyDoQuery	(	$offset,
		$limit,
		$descending )

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	$descending	Query direction, false for ascending, true for descending

Returns: IResultWrapper

Reimplemented from IndexPager.

Definition at line 118 of file ContribsPager.php.

References $fname, $options, $query, $tables, RangeChronologicalPager\buildQueryInfo(), getIndexField(), and list.

Member Data Documentation

◆ $mDb

ContribsPager::$mDb

Definition at line 37 of file ContribsPager.php.

◆ $mDbSecondary

IDatabase ContribsPager::$mDbSecondary

Definition at line 41 of file ContribsPager.php.

◆ $mDefaultDirection

ContribsPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Definition at line 33 of file ContribsPager.php.

◆ $messages

ContribsPager::$messages

Definition at line 34 of file ContribsPager.php.

◆ $mParentLens

array ContribsPager::$mParentLens

protected

Definition at line 46 of file ContribsPager.php.

◆ $namespace

ContribsPager::$namespace = ''

Definition at line 36 of file ContribsPager.php.

◆ $preventClickjacking

ContribsPager::$preventClickjacking = false

Definition at line 38 of file ContribsPager.php.

◆ $target

ContribsPager::$target

Definition at line 35 of file ContribsPager.php.

Referenced by getDefaultQuery().

◆ $templateParser

TemplateParser ContribsPager::$templateParser

protected

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

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doBatchLookups()

◆ formatRow()

◆ getDefaultQuery()

◆ getEndBody()

◆ getIndexField()

◆ getIpRangeConds()

◆ getNamespaceCond()

◆ getPreventClickjacking()

◆ getQueryInfo()

◆ getSqlComment()

◆ getStartBody()

◆ isQueryableRange()

◆ preventClickjacking()

◆ processDateFilter()

◆ reallyDoQuery()

Member Data Documentation

◆ $mDb

◆ $mDbSecondary

◆ $mDefaultDirection

◆ $messages

◆ $mParentLens

◆ $namespace

◆ $preventClickjacking

◆ $target

◆ $templateParser