MediaWiki
master
|
Pager for Special:Contributions. More...
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) | |
formatRow ( $row) | |
Generates each row in the contributions list. More... | |
getDefaultQuery () | |
Get an array of query parameters that should be put into self-links. More... | |
getIndexField () | |
getNamespace () | |
getNavigationBar () | |
Wrap the navigation bar in a p element with identifying class. More... | |
getPreventClickjacking () | |
getQueryInfo () | |
Provides all parameters needed for the main paged query. More... | |
getTagFilter () | |
getTarget () | |
isNewOnly () | |
isQueryableRange ( $ipRange) | |
Is the given IP a range and within the CIDR limit? More... | |
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. More... | |
tryCreatingRevisionRecord ( $row, $title=null) | |
Check whether the revision associated is valid for formatting. More... | |
tryToCreateValidRevision ( $row, $title=null) | |
Check whether the revision associated is valid for formatting. More... | |
![]() | |
getDateCond ( $year, $month, $day=-1) | |
Takes ReverseChronologicalPager::getDateCond parameters and repurposes them to work with timestamp-based getDateRangeCond. More... | |
getDateRangeCond ( $startStamp, $endStamp) | |
Set and return a date range condition using timestamps provided by the user. More... | |
![]() | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
doQuery () | |
Do the query, using information from the object context. More... | |
getBody () | |
Get the formatted result list. More... | |
getDatabase () | |
Get the Database object in use. More... | |
getLimit () | |
Get the current limit. More... | |
getNumRows () | |
Get the number of rows in the result set. More... | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. More... | |
getResult () | |
setIncludeOffset ( $include) | |
Set whether a row matching exactly the offset should be also included in the result or not. More... | |
setLimit ( $limit) | |
Set the limit from an other source than the request. More... | |
setOffset ( $offset) | |
Set the offset from an other source than the request. More... | |
![]() | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). More... | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. More... | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. More... | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() More... | |
setContext (IContextSource $context) | |
Static Public Member Functions | |
static | processDateFilter (array $opts) |
Set up date filter options, given request data. More... | |
![]() | |
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. More... | |
Protected Member Functions | |
doBatchLookups () | |
Called from getBody(), before getStartBody() is called and after doQuery() was called. More... | |
getEndBody () | |
getExtraSortFields () | |
getNamespaceCond () | |
getSqlComment () | |
Overwrite Pager function and return a helpful comment. More... | |
getStartBody () | |
preventClickjacking () | |
![]() | |
buildQueryInfo ( $offset, $limit, $order) | |
Build variables to use by the database wrapper. More... | |
![]() | |
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. More... | |
extractResultInfo ( $isFirst, $limit, IResultWrapper $res) | |
Extract some useful data from the result object for use by the navigation bar, put it into $this. More... | |
getDefaultDirections () | |
Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More... | |
getEmptyBody () | |
Hook into getBody(), for the bit between the start and the end when there are no rows. More... | |
getLimitLinks () | |
getLinkRenderer () | |
getPagingLinks ( $linkTexts, $disabledTexts=[]) | |
Get paging links. More... | |
isNavigationBarShown () | |
Returns whether to show the "navigation bar" @stable to override. More... | |
makeLink ( $text, array $query=null, $type=null) | |
Make a self-link. More... | |
preprocessResults ( $result) | |
Pre-process results; useful for performing batch existence checks, etc. More... | |
Private Member Functions | |
getIpRangeConds ( $db, $ip) | |
Get SQL conditions for an IP range, if applicable. More... | |
getTargetTable () | |
Return the table targeted for ordering and continuation. More... | |
Private Attributes | |
ActorMigration | $actorMigration |
bool | $associated |
Set to true to show both the subject and talk namespace, no matter which got selected. More... | |
bool | $deletedOnly |
Set to true to show only deleted revisions. More... | |
bool | $hideMinor |
Set to true to hide edits marked as minor by the user. More... | |
HookRunner | $hookRunner |
LinkBatchFactory | $linkBatchFactory |
string[] | $messages |
Local cache for escaped messages. More... | |
array | $mParentLens |
string int | $namespace = '' |
A single namespace number, or an empty string for all namespaces. More... | |
NamespaceInfo | $namespaceInfo |
bool | $newOnly |
Set to true to show only new pages. More... | |
bool | $nsInvert |
Set to true to invert the namespace selection. More... | |
$preventClickjacking = false | |
bool | $revisionsOnly |
Set to true to only include mediawiki revisions. More... | |
RevisionStore | $revisionStore |
string false | $tagFilter |
Name of tag to filter, or false to ignore tags. More... | |
string | $target |
User name, or a string describing an IP address range. More... | |
TemplateParser | $templateParser |
bool | $topOnly |
Set to true to show only latest (a.k.a. More... | |
Additional Inherited Members | |
![]() | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
int | $mMonth |
int | $mYear |
![]() | |
IDatabase | $mDb |
bool | $mDefaultDirection |
$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More... | |
int | $mDefaultLimit = 50 |
The default entry limit choosen for clients. More... | |
bool | $mIsBackwards |
bool | $mIsFirst |
True if the current result set is the first one. More... | |
bool | $mIsLast |
int | $mLimit |
The maximum number of entries to show. More... | |
int[] | $mLimitsShown = [ 20, 50, 100, 250, 500 ] |
List of default entry limit options to be presented to clients. More... | |
mixed | $mOffset |
The starting point to enumerate entries. More... | |
stdClass bool null | $mPastTheEndRow |
Extra row fetched at the end to see if the end was reached. More... | |
bool | $mQueryDone = false |
Whether the listing query completed. More... | |
WebRequest | $mRequest |
IResultWrapper | $mResult |
Result object for the query. More... | |
const | DIR_ASCENDING = false |
Backwards-compatible constant for $mDefaultDirection field (do not change) More... | |
const | DIR_DESCENDING = true |
Backwards-compatible constant for $mDefaultDirection field (do not change) More... | |
const | QUERY_ASCENDING = true |
Backwards-compatible constant for reallyDoQuery() (do not change) More... | |
const | QUERY_DESCENDING = false |
Backwards-compatible constant for reallyDoQuery() (do not change) More... | |
![]() | |
static | oppositeOrder ( $order) |
![]() | |
string[] | $rangeConds = [] |
![]() | |
array | $mDefaultQuery |
string[] | $mExtraSortFields |
An array of secondary columns to order by. More... | |
array | $mFirstShown |
bool | $mIncludeOffset = false |
Whether to include the offset in the query. More... | |
string string[] | $mIndexField |
The index to actually be used for ordering. More... | |
array | $mLastShown |
string | $mNavigationBar |
string null | $mOrderType |
For pages that support multiple types of ordering, which one to use. More... | |
array | $mPastTheEndIndex |
Pager for Special:Contributions.
Definition at line 39 of file ContribsPager.php.
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 |
||
) |
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 |
Definition at line 136 of file ContribsPager.php.
References $actorMigration, ContextSource\$context, $linkBatchFactory, IndexPager\$linkRenderer, $namespaceInfo, $revisionStore, DB_REPLICA, RangeChronologicalPager\getDateRangeCond(), and ContextSource\msg().
|
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.
@stable to override
Reimplemented from IndexPager.
Definition at line 539 of file ContribsPager.php.
References NS_USER_TALK.
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.
stdClass | $row |
Reimplemented from IndexPager.
Definition at line 639 of file ContribsPager.php.
References $lang, ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), getContext(), Linker\getRevDeleteLink(), Title\newFromRow(), Html\rawElement(), Linker\revComment(), ChangesList\revDateLink(), ChangesList\showCharacterDifference(), Linker\userLink(), Linker\userTalkLink(), and wfDebug().
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.
@stable to override
Reimplemented from IndexPager.
Definition at line 202 of file ContribsPager.php.
References $target.
|
protected |
|
protected |
Reimplemented from IndexPager.
Definition at line 518 of file ContribsPager.php.
References wfWarn().
ContribsPager::getIndexField | ( | ) |
Reimplemented from IndexPager.
Definition at line 466 of file ContribsPager.php.
References wfWarn().
Referenced by reallyDoQuery().
|
private |
Get SQL conditions for an IP range, if applicable.
IDatabase | $db | |
string | $ip | The IP address or CIDR |
Definition at line 430 of file ContribsPager.php.
ContribsPager::getNamespace | ( | ) |
Definition at line 511 of file ContribsPager.php.
|
protected |
Definition at line 401 of file ContribsPager.php.
References $dbr.
ContribsPager::getNavigationBar | ( | ) |
Wrap the navigation bar in a p element with identifying class.
In future we may want to change the p
tag to a div
and upstream this to the parent class.
Reimplemented from ReverseChronologicalPager.
Definition at line 216 of file ContribsPager.php.
References Html\rawElement().
Referenced by SpecialContributions\execute().
ContribsPager::getPreventClickjacking | ( | ) |
Definition at line 848 of file ContribsPager.php.
Referenced by SpecialContributions\execute().
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
Reimplemented from IndexPager.
Definition at line 321 of file ContribsPager.php.
References $dbr, $revQuery, getAuthority(), ChangeTags\modifyDisplayQuery(), and User\newFromName().
|
protected |
Overwrite Pager function and return a helpful comment.
Reimplemented from IndexPager.
Definition at line 832 of file ContribsPager.php.
|
protected |
ContribsPager::getTagFilter | ( | ) |
Definition at line 490 of file ContribsPager.php.
ContribsPager::getTarget | ( | ) |
Definition at line 497 of file ContribsPager.php.
|
private |
Return the table targeted for ordering and continuation.
See T200259 and T221380.
Definition at line 304 of file ContribsPager.php.
References $dbr, and User\newFromName().
ContribsPager::isNewOnly | ( | ) |
Definition at line 504 of file ContribsPager.php.
ContribsPager::isQueryableRange | ( | $ipRange | ) |
Is the given IP a range and within the CIDR limit?
string | $ipRange |
Definition at line 448 of file ContribsPager.php.
Referenced by SpecialContributions\execute().
|
protected |
Definition at line 841 of file ContribsPager.php.
|
static |
Set up date filter options, given request data.
array | $opts | Options array |
Definition at line 858 of file ContribsPager.php.
References ReverseChronologicalPager\getOffsetDate().
Referenced by SpecialContributions\execute(), and ApiFeedContributions\execute().
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.
string | $offset | Index offset, inclusive |
int | $limit | Exact query limit |
bool | $order | IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING |
Reimplemented from IndexPager.
Definition at line 231 of file ContribsPager.php.
References $dbr, RangeChronologicalPager\buildQueryInfo(), IndexPager\getDatabase(), and getIndexField().
ContribsPager::tryCreatingRevisionRecord | ( | $row, | |
$title = null |
|||
) |
Check whether the revision associated is valid for formatting.
If has no associated revision id then null is returned.
stdClass | $row | |
Title | null | $title |
Definition at line 608 of file ContribsPager.php.
References $title.
ContribsPager::tryToCreateValidRevision | ( | $row, | |
$title = null |
|||
) |
Check whether the revision associated is valid for formatting.
If has no associated revision id then null is returned.
stdClass | $row | |
Title | null | $title |
Definition at line 592 of file ContribsPager.php.
References $title, and wfDeprecated().
|
private |
Definition at line 117 of file ContribsPager.php.
Referenced by __construct().
|
private |
Set to true to show both the subject and talk namespace, no matter which got selected.
Definition at line 70 of file ContribsPager.php.
|
private |
Set to true to show only deleted revisions.
Definition at line 75 of file ContribsPager.php.
|
private |
Set to true to hide edits marked as minor by the user.
Definition at line 90 of file ContribsPager.php.
|
private |
Definition at line 114 of file ContribsPager.php.
|
private |
Definition at line 111 of file ContribsPager.php.
Referenced by __construct().
|
private |
Local cache for escaped messages.
Definition at line 44 of file ContribsPager.php.
|
private |
Definition at line 103 of file ContribsPager.php.
|
private |
A single namespace number, or an empty string for all namespaces.
Definition at line 54 of file ContribsPager.php.
|
private |
Definition at line 123 of file ContribsPager.php.
Referenced by __construct().
|
private |
Set to true to show only new pages.
Definition at line 85 of file ContribsPager.php.
|
private |
Set to true to invert the namespace selection.
Definition at line 64 of file ContribsPager.php.
|
private |
Definition at line 98 of file ContribsPager.php.
|
private |
Set to true to only include mediawiki revisions.
(restricts extensions from executing additional queries to include their own contributions)
Definition at line 96 of file ContribsPager.php.
|
private |
Definition at line 120 of file ContribsPager.php.
Referenced by __construct().
|
private |
Name of tag to filter, or false to ignore tags.
Definition at line 59 of file ContribsPager.php.
|
private |
User name, or a string describing an IP address range.
Definition at line 49 of file ContribsPager.php.
Referenced by getDefaultQuery().
|
private |
Definition at line 108 of file ContribsPager.php.
|
private |
Set to true to show only latest (a.k.a.
current) revisions
Definition at line 80 of file ContribsPager.php.