MediaWiki master
MediaWiki\Pager\ContribsPager Class Reference

Pager for Special:Contributions. More...

Inherits MediaWiki\Pager\RangeChronologicalPager.

Collaboration diagram for MediaWiki\Pager\ContribsPager:

Public Member Functions

 __construct (IContextSource $context, array $options, LinkRenderer $linkRenderer=null, LinkBatchFactory $linkBatchFactory=null, HookContainer $hookContainer=null, IConnectionProvider $dbProvider=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 ()
 
 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 MediaWiki\Pager\RangeChronologicalPager
 getDateRangeCond ( $startTime, $endTime)
 Set and return a date range condition using timestamps provided by the user.
 
 getRangeOffsets ()
 Return the range of date offsets, in the format of [ endOffset, startOffset ].
 
- Public Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
 getDateCond ( $year, $month, $day=-1)
 Set and return the offset timestamp such that we can get all revisions with a timestamp up to the specified parameters.
 
 getEndOffset ()
 Return the end offset, extensions can use this if they are not in the context of subclass.
 
 getNavigationBar ()
 
 getTimestampField ()
 Returns the name of the timestamp field.
 
- Public Member Functions inherited from MediaWiki\Pager\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 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 ()
 
 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 isQueryableRange ( $ipRange, $config)
 Is the given IP a range and within the CIDR limit?
 
static processDateFilter (array $opts)
 Set up date filter options, given request data.
 
- Static Public Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
static getOffsetDate ( $year, $month, $day=-1)
 Core logic of determining the offset timestamp such that we can get all items with a timestamp up to the specified parameters.
 

Public Attributes

 $mGroupByDate = true
 
- Public Attributes inherited from MediaWiki\Pager\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 MediaWiki\Pager\IndexPager
IReadableDatabase $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 MediaWiki\Pager\RangeChronologicalPager
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper.
Note
For b/c, query direction is true for ascending and false for descending
Stability: stable
to override
Parameters
int | string | null$offsetIndex offset, inclusive
int$limitExact query limit
bool$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
array

 
- Protected Member Functions inherited from MediaWiki\Pager\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 MediaWiki\Pager\IndexPager
 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.
 
 getLinkRenderer ()
 
 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 MediaWiki\Pager\IndexPager
static oppositeOrder ( $order)
 
- Protected Attributes inherited from MediaWiki\Pager\RangeChronologicalPager
string[] $rangeConds
 
string $startOffset
 
- Protected Attributes inherited from MediaWiki\Pager\ReverseChronologicalPager
string $endOffset
 
- Protected Attributes inherited from MediaWiki\Pager\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 60 of file ContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\ContribsPager::__construct ( IContextSource  $context,
array  $options,
LinkRenderer  $linkRenderer = null,
LinkBatchFactory  $linkBatchFactory = null,
HookContainer  $hookContainer = null,
IConnectionProvider  $dbProvider = 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
IConnectionProvider | null$dbProvider
RevisionStore | null$revisionStore
NamespaceInfo | null$namespaceInfo
UserIdentity | null$targetUser
CommentFormatter | null$commentFormatter

Definition at line 165 of file ContribsPager.php.

References MediaWiki\Pager\RangeChronologicalPager\getDateRangeCond(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\User\UserIdentity\getName(), and MediaWiki\Context\ContextSource\msg().

Member Function Documentation

◆ doBatchLookups()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 569 of file ContribsPager.php.

References getAuthority(), and NS_USER_TALK.

◆ formatRow()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 659 of file ContribsPager.php.

References ChangeTags\formatSummaryRow(), getAuthority(), getContext(), and wfDebug().

◆ getDefaultQuery()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 252 of file ContribsPager.php.

◆ getEndBody()

MediaWiki\Pager\ContribsPager::getEndBody ( )
protected

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

Stability: stable
to override
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 621 of file ContribsPager.php.

◆ getExtraSortFields()

MediaWiki\Pager\ContribsPager::getExtraSortFields ( )
protected
Returns
string[]

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 550 of file ContribsPager.php.

References wfWarn().

◆ getIndexField()

MediaWiki\Pager\ContribsPager::getIndexField ( )
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 500 of file ContribsPager.php.

References wfWarn().

Referenced by MediaWiki\Pager\ContribsPager\reallyDoQuery().

◆ getNamespace()

MediaWiki\Pager\ContribsPager::getNamespace ( )
Returns
int|string

Definition at line 543 of file ContribsPager.php.

◆ getNamespaceCond()

MediaWiki\Pager\ContribsPager::getNamespaceCond ( )
protected

Definition at line 433 of file ContribsPager.php.

◆ getPreventClickjacking()

MediaWiki\Pager\ContribsPager::getPreventClickjacking ( )
Returns
bool

Definition at line 902 of file ContribsPager.php.

Referenced by MediaWiki\Specials\SpecialContributions\execute().

◆ getQueryInfo()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 357 of file ContribsPager.php.

References getAuthority(), and ChangeTags\modifyDisplayQuery().

◆ getSqlComment()

MediaWiki\Pager\ContribsPager::getSqlComment ( )
protected

Overwrite Pager function and return a helpful comment.

Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 875 of file ContribsPager.php.

◆ getStartBody()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 614 of file ContribsPager.php.

◆ getTagFilter()

MediaWiki\Pager\ContribsPager::getTagFilter ( )
Returns
false|string[]

Definition at line 522 of file ContribsPager.php.

◆ getTarget()

MediaWiki\Pager\ContribsPager::getTarget ( )
Returns
string

Definition at line 529 of file ContribsPager.php.

◆ isNewOnly()

MediaWiki\Pager\ContribsPager::isNewOnly ( )
Returns
bool

Definition at line 536 of file ContribsPager.php.

◆ isQueryableRange()

static MediaWiki\Pager\ContribsPager::isQueryableRange (   $ipRange,
  $config 
)
static

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

Access: internal
Public only for SpecialContributions
Parameters
string$ipRange
Config$config
Returns
bool True if it is valid
Since
1.30

Definition at line 482 of file ContribsPager.php.

References MediaWiki\MainConfigNames\RangeContributionsCIDRLimit.

◆ preventClickjacking()

MediaWiki\Pager\ContribsPager::preventClickjacking ( )
protected
Deprecated:
since 1.38, use ::setPreventClickjacking() instead

Definition at line 887 of file ContribsPager.php.

◆ processDateFilter()

static MediaWiki\Pager\ContribsPager::processDateFilter ( array  $opts)
static

Set up date filter options, given request data.

Parameters
array$optsOptions array
Returns
array Options array with processed start and end date filter options

Definition at line 912 of file ContribsPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\getOffsetDate().

◆ reallyDoQuery()

MediaWiki\Pager\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$offsetIndex offset, inclusive
int$limitExact query limit
bool$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
IResultWrapper

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 268 of file ContribsPager.php.

References MediaWiki\Pager\RangeChronologicalPager\buildQueryInfo(), MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Pager\IndexPager\getDatabase(), MediaWiki\Pager\ContribsPager\getIndexField(), and MediaWiki\MainConfigNames\MaxExecutionTimeForExpensiveQueries.

◆ setPreventClickjacking()

MediaWiki\Pager\ContribsPager::setPreventClickjacking ( bool  $enable)
protected
Parameters
bool$enable
Since
1.38

Definition at line 895 of file ContribsPager.php.

◆ tryCreatingRevisionRecord()

MediaWiki\Pager\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 635 of file ContribsPager.php.

Member Data Documentation

◆ $mGroupByDate

MediaWiki\Pager\ContribsPager::$mGroupByDate = true

Definition at line 62 of file ContribsPager.php.


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