MediaWiki master
|
Pager for Special:Contributions. More...
Inherits MediaWiki\Pager\RangeChronologicalPager.
Inherited by MediaWiki\Pager\ContribsPager, and MediaWiki\Pager\DeletedContribsPager.
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 () | |
getProcessedTemplate ( $templateParams) | |
Return the processed template. | |
getQueryInfo () | |
Provides all parameters needed for the main paged query. | |
getTagFilter () | |
getTagInvert () | |
getTarget () | |
getTemplateParams ( $row, &$classes) | |
Generate array of template parameters to pass to the template for rendering. | |
hasAppliedFilters () | |
Whether the pager has any filters applied, ignoring whether the target username / IP for this check. | |
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. | |
revisionUserIsDeleted ( $row) | |
Check whether the revision author is deleted. | |
tryCreatingRevisionRecord ( $row, $title=null) | |
If the object looks like a revision row, or corresponds to a previously cached revision, return the RevisionRecord. | |
![]() | |
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 ]. | |
![]() | |
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. | |
![]() | |
__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. | |
![]() | |
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 | |
![]() | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
bool | $mGroupByDate = false |
Whether to group items by date. | |
int | $mMonth |
int | $mYear |
![]() | |
IReadableDatabase | $mDb |
bool null | $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. | ||||||||||
formatArticleLink ( $row) | ||||||||||
Format a link to an article. | ||||||||||
formatCharDiff ( $row) | ||||||||||
Format annotation to show the size of a diff. | ||||||||||
formatComment ( $row) | ||||||||||
Format a comment for a revision. | ||||||||||
formatDateLink ( $row) | ||||||||||
Format a date link. | ||||||||||
formatDiffHistLinks ( $row) | ||||||||||
Format diff and history links. | ||||||||||
formatFlags ( $row) | ||||||||||
formatTags ( $row, &$classes) | ||||||||||
formatTopMarkText ( $row, &$classes) | ||||||||||
Format annotation and add extra class if a row represents a latest revision. | ||||||||||
formatUserLink ( $row) | ||||||||||
Format a user link. | ||||||||||
formatVisibilityLink ( $row) | ||||||||||
Format link for changing visibility. | ||||||||||
getEmptyBody () | ||||||||||
Hook into getBody(), for the bit between the start and the end when there are no rows.
| ||||||||||
getEndBody () | ||||||||||
Hook into getBody() for the end of the list.
| ||||||||||
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.
| ||||||||||
populateAttributes ( $row, &$attributes) | ||||||||||
Populate the HTML attributes. | ||||||||||
preventClickjacking () | ||||||||||
setPreventClickjacking (bool $enable) | ||||||||||
![]() | ||||||||||
buildQueryInfo ( $offset, $limit, $order) | ||||||||||
Build variables to use by the database wrapper.
| ||||||||||
![]() | ||||||||||
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.
| ||||||||||
getHeaderRow (string $date) | ||||||||||
getRow ( $row) | ||||||||||
Get the HTML of a pager row.
| ||||||||||
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. | ||||||||||
![]() | ||||||||||
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. | ||||||||||
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 | |
Title | $currentPage |
RevisionRecord | $currentRevRecord |
bool | $isArchive |
Get revisions from the archive table (if true) or the revision table (if false) | |
string[] | $messages |
Local cache for escaped messages. | |
NamespaceInfo | $namespaceInfo |
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' |
bool | $runHooks |
Run hooks to allow extensions to modify the page. | |
string | $target |
User name, or a string describing an IP address range. | |
UserIdentity | $targetUser |
TemplateParser | $templateParser |
Set to protected to allow subclasses access for overrides. | |
string | $userNameField = 'rev_user_text' |
![]() | |
string[] | $rangeConds |
string | $startOffset |
![]() | |
string | $endOffset |
![]() | |
array null | $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 null | $mNavigationBar |
string null | $mOrderType |
For pages that support multiple types of ordering, which one to use. | |
array | $mPastTheEndIndex |
Additional Inherited Members | |
![]() | |
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 | oppositeOrder ( $order) |
Pager for Special:Contributions.
Definition at line 57 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::__construct | ( | LinkRenderer | $linkRenderer, |
LinkBatchFactory | $linkBatchFactory, | ||
HookContainer | $hookContainer, | ||
RevisionStore | $revisionStore, | ||
NamespaceInfo | $namespaceInfo, | ||
CommentFormatter | $commentFormatter, | ||
UserFactory | $userFactory, | ||
IContextSource | $context, | ||
array | $options, | ||
?UserIdentity | $targetUser ) |
LinkRenderer | $linkRenderer | |
LinkBatchFactory | $linkBatchFactory | |
HookContainer | $hookContainer | |
RevisionStore | $revisionStore | |
NamespaceInfo | $namespaceInfo | |
CommentFormatter | $commentFormatter | |
UserFactory | $userFactory | |
IContextSource | $context | |
array | $options | |
UserIdentity | null | $targetUser |
Definition at line 194 of file ContributionsPager.php.
References MediaWiki\Pager\ContributionsPager\$namespaceInfo, 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().
MediaWiki\Pager\ContributionsPager::createRevisionRecord | ( | $row, | |
$title = null ) |
Create a revision record from a $row that models a revision.
mixed | $row | |
Title | null | $title |
Definition at line 646 of file ContributionsPager.php.
|
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.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 520 of file ContributionsPager.php.
|
protected |
Format a link to an article.
mixed | $row |
Definition at line 670 of file ContributionsPager.php.
|
protected |
Format annotation to show the size of a diff.
mixed | $row |
Definition at line 862 of file ContributionsPager.php.
|
protected |
Format a comment for a revision.
mixed | $row |
Definition at line 893 of file ContributionsPager.php.
|
protected |
Format a date link.
mixed | $row |
Definition at line 778 of file ContributionsPager.php.
|
protected |
Format diff and history links.
mixed | $row |
Definition at line 689 of file ContributionsPager.php.
|
protected |
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.
stdClass | mixed | $row |
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 1019 of file ContributionsPager.php.
|
protected |
mixed | $row | |
string[] | &$classes |
Definition at line 979 of file ContributionsPager.php.
|
protected |
Format annotation and add extra class if a row represents a latest revision.
mixed | $row | |
string[] | &$classes |
Definition at line 829 of file ContributionsPager.php.
|
protected |
Format a user link.
mixed | $row |
Definition at line 911 of file ContributionsPager.php.
|
protected |
Format link for changing visibility.
mixed | $row |
Definition at line 959 of file ContributionsPager.php.
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.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 283 of file ContributionsPager.php.
References MediaWiki\Pager\ContributionsPager\$target.
|
protected |
Hook into getBody(), for the bit between the start and the end when there are no rows.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 601 of file ContributionsPager.php.
|
protected |
Hook into getBody() for the end of the list.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 594 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::getNamespace | ( | ) |
Definition at line 499 of file ContributionsPager.php.
|
protected |
Definition at line 454 of file ContributionsPager.php.
References MediaWiki\Pager\IndexPager\getDatabase().
Referenced by MediaWiki\Pager\ContributionsPager\getQueryInfo().
MediaWiki\Pager\ContributionsPager::getPreventClickjacking | ( | ) |
Definition at line 1169 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::getProcessedTemplate | ( | $templateParams | ) |
Return the processed template.
Function can be overriden by classes to provide their own template parser.
string[] | $templateParams |
Definition at line 1131 of file ContributionsPager.php.
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
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 391 of file ContributionsPager.php.
References MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\Pager\IndexPager\getDatabase(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Pager\ContributionsPager\getNamespaceCond(), and MediaWiki\Pager\ContributionsPager\getRevisionQuery().
|
abstractprotected |
Get queryInfo for the main query selecting revisions, not including filtering on namespace, date, etc.
Reimplemented in MediaWiki\Pager\ContribsPager, and MediaWiki\Pager\DeletedContribsPager.
Referenced by MediaWiki\Pager\ContributionsPager\getQueryInfo().
|
protected |
Overwrite Pager function and return a helpful comment.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 1142 of file ContributionsPager.php.
|
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.
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 587 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::getTagFilter | ( | ) |
Definition at line 471 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::getTagInvert | ( | ) |
Definition at line 478 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::getTarget | ( | ) |
Definition at line 485 of file ContributionsPager.php.
References MediaWiki\Pager\ContributionsPager\$target.
MediaWiki\Pager\ContributionsPager::getTemplateParams | ( | $row, | |
& | $classes ) |
Generate array of template parameters to pass to the template for rendering.
Function can be overriden by classes to add/remove their own parameters.
stdClass | mixed | $row | |
string[] | &$classes |
Definition at line 1083 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::hasAppliedFilters | ( | ) |
Whether the pager has any filters applied, ignoring whether the target username / IP for this check.
Used to determine whether the current search may produce results if the filters were changed for UI messages when no results are displayed.
Currently does not support checking if filters added via the onSpecialContributions__getForm__filters hook are applied to the current query.
Definition at line 515 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::isNewOnly | ( | ) |
Definition at line 492 of file ContributionsPager.php.
|
protected |
Populate the HTML attributes.
mixed | $row | |
string[] | &$attributes |
Definition at line 660 of file ContributionsPager.php.
|
protected |
Definition at line 1154 of file ContributionsPager.php.
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.
string | $offset | Index offset, inclusive |
int | $limit | Exact query limit |
bool | $order | IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING |
Reimplemented from MediaWiki\Pager\IndexPager.
Definition at line 299 of file ContributionsPager.php.
References MediaWiki\Pager\RangeChronologicalPager\buildQueryInfo(), MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Pager\IndexPager\getDatabase(), and MediaWiki\MainConfigNames\MaxExecutionTimeForExpensiveQueries.
MediaWiki\Pager\ContributionsPager::revisionUserIsDeleted | ( | $row | ) |
Check whether the revision author is deleted.
mixed | $row |
Definition at line 1003 of file ContributionsPager.php.
|
protected |
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.
mixed | $row | |
Title | null | $title |
Definition at line 615 of file ContributionsPager.php.
|
protected |
Definition at line 137 of file ContributionsPager.php.
|
protected |
Definition at line 138 of file ContributionsPager.php.
|
protected |
Get revisions from the archive table (if true) or the revision table (if false)
Definition at line 70 of file ContributionsPager.php.
|
protected |
Local cache for escaped messages.
Definition at line 65 of file ContributionsPager.php.
MediaWiki\Pager\ContributionsPager::$mGroupByDate = true |
Definition at line 60 of file ContributionsPager.php.
|
protected |
Definition at line 156 of file ContributionsPager.php.
Referenced by MediaWiki\Pager\DeletedContribsPager\__construct(), MediaWiki\Pager\ContribsPager\__construct(), and MediaWiki\Pager\ContributionsPager\__construct().
|
protected |
Definition at line 179 of file ContributionsPager.php.
|
protected |
Definition at line 180 of file ContributionsPager.php.
|
protected |
Definition at line 176 of file ContributionsPager.php.
|
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 172 of file ContributionsPager.php.
|
protected |
Definition at line 175 of file ContributionsPager.php.
|
protected |
Definition at line 177 of file ContributionsPager.php.
|
protected |
Definition at line 173 of file ContributionsPager.php.
|
protected |
Definition at line 157 of file ContributionsPager.php.
Referenced by MediaWiki\Pager\DeletedContribsPager\__construct(), MediaWiki\Pager\ContribsPager\__construct(), and MediaWiki\Pager\ContributionsPager\__construct().
|
protected |
Definition at line 174 of file ContributionsPager.php.
|
protected |
Run hooks to allow extensions to modify the page.
Definition at line 75 of file ContributionsPager.php.
|
protected |
User name, or a string describing an IP address range.
Definition at line 80 of file ContributionsPager.php.
Referenced by MediaWiki\Pager\DeletedContribsPager\__construct(), MediaWiki\Pager\ContributionsPager\getDefaultQuery(), MediaWiki\Pager\ContribsPager\getExtraSortFields(), MediaWiki\Pager\ContribsPager\getIndexField(), and MediaWiki\Pager\ContributionsPager\getTarget().
|
protected |
Definition at line 146 of file ContributionsPager.php.
Referenced by MediaWiki\Pager\ContribsPager\__construct(), and MediaWiki\Pager\ContributionsPager\__construct().
|
protected |
Set to protected to allow subclasses access for overrides.
Definition at line 151 of file ContributionsPager.php.
|
protected |
Definition at line 178 of file ContributionsPager.php.