MediaWiki  master
ContribsPager Class Reference

Pager for Special:Contributions. More...

Inheritance diagram for ContribsPager:
Collaboration diagram for ContribsPager:

Public Member Functions

 __construct (IContextSource $context, array $options, LinkRenderer $linkRenderer=null, LinkBatchFactory $linkBatchFactory=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...
 
- Public Member Functions inherited from RangeChronologicalPager
 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...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 Stable to call. More...
 
 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...
 
- Public Member Functions inherited from ContextSource
 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...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 Stable to override. More...
 
 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 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. 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 ()
 
- Protected Member Functions inherited from RangeChronologicalPager
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
- Protected Member Functions inherited from IndexPager
 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

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...
 
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...
 
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...
 
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

- Public Attributes inherited from ReverseChronologicalPager
int $mDay
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 
int $mMonth
 
int $mYear
 
- Public Attributes inherited from IndexPager
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 Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 
- Protected Attributes inherited from RangeChronologicalPager
string[] $rangeConds = []
 
- Protected Attributes inherited from IndexPager
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
 

Detailed Description

Pager for Special:Contributions.

Definition at line 35 of file ContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

ContribsPager::__construct ( IContextSource  $context,
array  $options,
LinkRenderer  $linkRenderer = null,
LinkBatchFactory  $linkBatchFactory = null 
)

Member Function Documentation

◆ doBatchLookups()

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.

@stable to override

Returns
void

Reimplemented from IndexPager.

Definition at line 500 of file ContribsPager.php.

References 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 601 of file ContribsPager.php.

References $lang, ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), getContext(), Linker\getRevDeleteLink(), getUser(), Title\newFromRow(), Html\rawElement(), Linker\revComment(), ChangesList\revDateLink(), ChangesList\showCharacterDifference(), Linker\userLink(), Linker\userTalkLink(), 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.

@stable to override

Returns
array Associative array

Reimplemented from IndexPager.

Definition at line 161 of file ContribsPager.php.

References $target.

◆ getEndBody()

ContribsPager::getEndBody ( )
protected
Returns
string

Reimplemented from IndexPager.

Definition at line 539 of file ContribsPager.php.

◆ getExtraSortFields()

ContribsPager::getExtraSortFields ( )
protected
Returns
string[]

Reimplemented from IndexPager.

Definition at line 479 of file ContribsPager.php.

References wfWarn().

◆ getIndexField()

ContribsPager::getIndexField ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 427 of file ContribsPager.php.

References wfWarn().

Referenced by reallyDoQuery().

◆ getIpRangeConds()

ContribsPager::getIpRangeConds (   $db,
  $ip 
)
private

Get SQL conditions for an IP range, if applicable.

Parameters
IDatabase$db
string$ipThe IP address or CIDR
Returns
string|false SQL for valid IP ranges, false if invalid

Definition at line 391 of file ContribsPager.php.

◆ getNamespace()

ContribsPager::getNamespace ( )
Returns
int|string

Definition at line 472 of file ContribsPager.php.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )
protected

Definition at line 361 of file ContribsPager.php.

◆ getNavigationBar()

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.

Returns
string HTML

Reimplemented from ReverseChronologicalPager.

Definition at line 175 of file ContribsPager.php.

References Html\rawElement().

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )
Returns
bool

Definition at line 815 of file ContribsPager.php.

◆ getQueryInfo()

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 IndexPager.

Definition at line 278 of file ContribsPager.php.

References $revQuery, getUser(), ChangeTags\modifyDisplayQuery(), User\newFromName(), and ActorMigration\newMigration().

◆ getSqlComment()

ContribsPager::getSqlComment ( )
protected

Overwrite Pager function and return a helpful comment.

Returns
string

Reimplemented from IndexPager.

Definition at line 799 of file ContribsPager.php.

◆ getStartBody()

ContribsPager::getStartBody ( )
protected
Returns
string

Reimplemented from IndexPager.

Definition at line 532 of file ContribsPager.php.

◆ getTagFilter()

ContribsPager::getTagFilter ( )
Returns
false|string

Definition at line 451 of file ContribsPager.php.

◆ getTarget()

ContribsPager::getTarget ( )
Returns
string

Definition at line 458 of file ContribsPager.php.

◆ getTargetTable()

ContribsPager::getTargetTable ( )
private

Return the table targeted for ordering and continuation.

See T200259 and T221380.

Warning
Keep this in sync with self::getQueryInfo()!
Returns
string

Definition at line 262 of file ContribsPager.php.

References User\newFromName(), and ActorMigration\newMigration().

◆ isNewOnly()

ContribsPager::isNewOnly ( )
Returns
bool

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

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )
protected

Definition at line 808 of file ContribsPager.php.

◆ processDateFilter()

static 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 825 of file ContribsPager.php.

References ReverseChronologicalPager\getOffsetDate().

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

◆ reallyDoQuery()

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 IndexPager.

Definition at line 190 of file ContribsPager.php.

References RangeChronologicalPager\buildQueryInfo(), and getIndexField().

◆ tryCreatingRevisionRecord()

ContribsPager::tryCreatingRevisionRecord (   $row,
  $title = null 
)

Check whether the revision associated is valid for formatting.

If has no associated revision id then null is returned.

Since
1.35
Parameters
object$row
Title | null$title
Returns
RevisionRecord|null

Definition at line 569 of file ContribsPager.php.

References $title.

◆ tryToCreateValidRevision()

ContribsPager::tryToCreateValidRevision (   $row,
  $title = null 
)

Check whether the revision associated is valid for formatting.

If has no associated revision id then null is returned.

Deprecated:
since 1.35
Parameters
object$row
Title | null$title
Returns
Revision|null

Definition at line 553 of file ContribsPager.php.

References $title, and wfDeprecated().

Member Data Documentation

◆ $associated

bool ContribsPager::$associated
private

Set to true to show both the subject and talk namespace, no matter which got selected.

Definition at line 66 of file ContribsPager.php.

◆ $deletedOnly

bool ContribsPager::$deletedOnly
private

Set to true to show only deleted revisions.

Definition at line 71 of file ContribsPager.php.

◆ $hideMinor

bool ContribsPager::$hideMinor
private

Set to true to hide edits marked as minor by the user.

Definition at line 86 of file ContribsPager.php.

◆ $linkBatchFactory

LinkBatchFactory ContribsPager::$linkBatchFactory
private

Definition at line 107 of file ContribsPager.php.

Referenced by __construct().

◆ $messages

string [] ContribsPager::$messages
private

Local cache for escaped messages.

Definition at line 40 of file ContribsPager.php.

◆ $mParentLens

array ContribsPager::$mParentLens
private

Definition at line 99 of file ContribsPager.php.

◆ $namespace

string int ContribsPager::$namespace = ''
private

A single namespace number, or an empty string for all namespaces.

Definition at line 50 of file ContribsPager.php.

◆ $newOnly

bool ContribsPager::$newOnly
private

Set to true to show only new pages.

Definition at line 81 of file ContribsPager.php.

◆ $nsInvert

bool ContribsPager::$nsInvert
private

Set to true to invert the namespace selection.

Definition at line 60 of file ContribsPager.php.

◆ $preventClickjacking

ContribsPager::$preventClickjacking = false
private

Definition at line 94 of file ContribsPager.php.

◆ $revisionsOnly

bool ContribsPager::$revisionsOnly
private

Set to true to only include mediawiki revisions.

(restricts extensions from executing additional queries to include their own contributions)

Definition at line 92 of file ContribsPager.php.

◆ $tagFilter

string false ContribsPager::$tagFilter
private

Name of tag to filter, or false to ignore tags.

Definition at line 55 of file ContribsPager.php.

◆ $target

string ContribsPager::$target
private

User name, or a string describing an IP address range.

Definition at line 45 of file ContribsPager.php.

Referenced by getDefaultQuery().

◆ $templateParser

TemplateParser ContribsPager::$templateParser
private

Definition at line 104 of file ContribsPager.php.

◆ $topOnly

bool ContribsPager::$topOnly
private

Set to true to show only latest (a.k.a.

current) revisions

Definition at line 76 of file ContribsPager.php.


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