MediaWiki master
MediaWiki\Pager\ContributionsPager Class Reference

Pager for Special:Contributions. More...

Inherits MediaWiki\Pager\RangeChronologicalPager.

Inherited by MediaWiki\Pager\ContribsPager.

Collaboration diagram for MediaWiki\Pager\ContributionsPager:

Public Member Functions

 __construct (LinkRenderer $linkRenderer, LinkBatchFactory $linkBatchFactory, HookContainer $hookContainer, RevisionStore $revisionStore, NamespaceInfo $namespaceInfo, CommentFormatter $commentFormatter, UserFactory $userFactory, IContextSource $context, array $options, ?UserIdentity $targetUser)
 
 createRevisionRecord ( $row, $title=null)
 Create a revision record from a $row that models a revision.
 
 formatRow ( $row)
 Generates each row in the contributions list.
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links.
 
 getNamespace ()
 
 getPreventClickjacking ()
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query.
 
 getTagFilter ()
 
 getTagInvert ()
 
 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.
 
 getIndexField ()
 Returns the name of the index field.
 
 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)
 

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

 
 getNamespaceCond ()
 
 getRevisionQuery ()
 Get queryInfo for the main query selecting revisions, not including filtering on namespace, date, etc.
 
 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.
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField().
 
 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.
 

Protected Attributes

bool $isArchive
 Get revisions from the archive table (if true) or the revision table (if false)
 
string $pageNamespaceField = 'page_namespace'
 
string $pageTitleField = 'page_title'
 
string $revisionDeletedField = 'rev_deleted'
 
string $revisionIdField = 'rev_id'
 Field names for various attributes.
 
string $revisionLengthField = 'rev_len'
 
string $revisionMinorField = 'rev_minor_edit'
 
string $revisionParentIdField = 'rev_parent_id'
 
RevisionStore $revisionStore
 
string $revisionTimestampField = 'rev_timestamp'
 
string $target
 User name, or a string describing an IP address range.
 
UserIdentity $targetUser
 
string $userNameField = 'rev_user_text'
 
- 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
 

Additional Inherited Members

- 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.
 
- Static Protected Member Functions inherited from MediaWiki\Pager\IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Pager for Special:Contributions.

Definition at line 56 of file ContributionsPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\ContributionsPager::__construct ( LinkRenderer $linkRenderer,
LinkBatchFactory $linkBatchFactory,
HookContainer $hookContainer,
RevisionStore $revisionStore,
NamespaceInfo $namespaceInfo,
CommentFormatter $commentFormatter,
UserFactory $userFactory,
IContextSource $context,
array $options,
?UserIdentity $targetUser )
Parameters
LinkRenderer$linkRenderer
LinkBatchFactory$linkBatchFactory
HookContainer$hookContainer
RevisionStore$revisionStore
NamespaceInfo$namespaceInfo
CommentFormatter$commentFormatter
UserFactory$userFactory
IContextSource$context
array$options
UserIdentity | null$targetUser

Definition at line 179 of file ContributionsPager.php.

References MediaWiki\Pager\ContributionsPager\$revisionStore, MediaWiki\Pager\ContributionsPager\$targetUser, MediaWiki\Pager\RangeChronologicalPager\getDateRangeCond(), MediaWiki\User\UserIdentity\getName(), MediaWiki\Context\ContextSource\msg(), and MediaWiki\User\UserFactory\newFromName().

Member Function Documentation

◆ createRevisionRecord()

MediaWiki\Pager\ContributionsPager::createRevisionRecord ( $row,
$title = null )

Create a revision record from a $row that models a revision.

Parameters
mixed$row
Title | null$title
Returns
RevisionRecord

Definition at line 576 of file ContributionsPager.php.

◆ doBatchLookups()

MediaWiki\Pager\ContributionsPager::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 480 of file ContributionsPager.php.

◆ formatRow()

MediaWiki\Pager\ContributionsPager::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 596 of file ContributionsPager.php.

◆ getDefaultQuery()

MediaWiki\Pager\ContributionsPager::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 267 of file ContributionsPager.php.

References MediaWiki\Pager\ContributionsPager\$target.

◆ getEndBody()

MediaWiki\Pager\ContributionsPager::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 531 of file ContributionsPager.php.

◆ getNamespace()

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

Definition at line 476 of file ContributionsPager.php.

◆ getNamespaceCond()

MediaWiki\Pager\ContributionsPager::getNamespaceCond ( )
protected

Definition at line 422 of file ContributionsPager.php.

◆ getPreventClickjacking()

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

Definition at line 888 of file ContributionsPager.php.

◆ getQueryInfo()

MediaWiki\Pager\ContributionsPager::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 366 of file ContributionsPager.php.

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

◆ getRevisionQuery()

MediaWiki\Pager\ContributionsPager::getRevisionQuery ( )
abstractprotected

Get queryInfo for the main query selecting revisions, not including filtering on namespace, date, etc.

Returns
array

Reimplemented in MediaWiki\Pager\ContribsPager.

◆ getSqlComment()

MediaWiki\Pager\ContributionsPager::getSqlComment ( )
protected

Overwrite Pager function and return a helpful comment.

Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 861 of file ContributionsPager.php.

◆ getStartBody()

MediaWiki\Pager\ContributionsPager::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 524 of file ContributionsPager.php.

◆ getTagFilter()

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

Definition at line 448 of file ContributionsPager.php.

◆ getTagInvert()

MediaWiki\Pager\ContributionsPager::getTagInvert ( )
Returns
bool

Definition at line 455 of file ContributionsPager.php.

◆ getTarget()

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

Definition at line 462 of file ContributionsPager.php.

◆ isNewOnly()

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

Definition at line 469 of file ContributionsPager.php.

◆ preventClickjacking()

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

Definition at line 873 of file ContributionsPager.php.

◆ reallyDoQuery()

MediaWiki\Pager\ContributionsPager::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 283 of file ContributionsPager.php.

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

◆ setPreventClickjacking()

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

Definition at line 881 of file ContributionsPager.php.

◆ tryCreatingRevisionRecord()

MediaWiki\Pager\ContributionsPager::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 545 of file ContributionsPager.php.

Member Data Documentation

◆ $isArchive

bool MediaWiki\Pager\ContributionsPager::$isArchive
protected

Get revisions from the archive table (if true) or the revision table (if false)

Definition at line 68 of file ContributionsPager.php.

◆ $mGroupByDate

MediaWiki\Pager\ContributionsPager::$mGroupByDate = true

Definition at line 58 of file ContributionsPager.php.

◆ $pageNamespaceField

string MediaWiki\Pager\ContributionsPager::$pageNamespaceField = 'page_namespace'
protected

Definition at line 164 of file ContributionsPager.php.

◆ $pageTitleField

string MediaWiki\Pager\ContributionsPager::$pageTitleField = 'page_title'
protected

Definition at line 165 of file ContributionsPager.php.

◆ $revisionDeletedField

string MediaWiki\Pager\ContributionsPager::$revisionDeletedField = 'rev_deleted'
protected

Definition at line 161 of file ContributionsPager.php.

◆ $revisionIdField

string MediaWiki\Pager\ContributionsPager::$revisionIdField = 'rev_id'
protected

Field names for various attributes.

These may be overridden in a subclass, for example for getting revisions from the archive table.

Definition at line 157 of file ContributionsPager.php.

◆ $revisionLengthField

string MediaWiki\Pager\ContributionsPager::$revisionLengthField = 'rev_len'
protected

Definition at line 160 of file ContributionsPager.php.

◆ $revisionMinorField

string MediaWiki\Pager\ContributionsPager::$revisionMinorField = 'rev_minor_edit'
protected

Definition at line 162 of file ContributionsPager.php.

◆ $revisionParentIdField

string MediaWiki\Pager\ContributionsPager::$revisionParentIdField = 'rev_parent_id'
protected

Definition at line 158 of file ContributionsPager.php.

◆ $revisionStore

RevisionStore MediaWiki\Pager\ContributionsPager::$revisionStore
protected

◆ $revisionTimestampField

string MediaWiki\Pager\ContributionsPager::$revisionTimestampField = 'rev_timestamp'
protected

Definition at line 159 of file ContributionsPager.php.

◆ $target

string MediaWiki\Pager\ContributionsPager::$target
protected

◆ $targetUser

UserIdentity MediaWiki\Pager\ContributionsPager::$targetUser
protected

◆ $userNameField

string MediaWiki\Pager\ContributionsPager::$userNameField = 'rev_user_text'
protected

Definition at line 163 of file ContributionsPager.php.


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