MediaWiki  master
ContribsPager Class Reference
Inheritance diagram for ContribsPager:
Collaboration diagram for ContribsPager:

Public Member Functions

 __construct (IContextSource $context, array $options, LinkRenderer $linkRenderer=null)
 
 formatRow ( $row)
 Generates each row in the contributions list. More...
 
 getDefaultQuery ()
 
 getIndexField ()
 
 getNamespace ()
 
 getNamespaceCond ()
 
 getNavigationBar ()
 Wrap the navigation bar in a p element with identifying class. More...
 
 getPreventClickjacking ()
 
 getQueryInfo ()
 
 getSqlComment ()
 Overwrite Pager function and return a helpful comment. 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...
 
 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 ReverseChronologicalPager
 getDateCond ( $year, $month, $day=-1)
 Set and return the mOffset timestamp such that we can get all revisions with a timestamp up to the specified parameters. More...
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 
 doQuery ()
 Do the query, using information from the object context. 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...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getResult ()
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 reallyDoQuery ( $offset, $limit, $order)
 Do a query with specified parameters, rather than using the object context. More...
 
 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 ()
 
 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 ()
 
 getEndBody ()
 
 getExtraSortFields ()
 
 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...
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. 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...
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getExtraSortFields ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getLinkRenderer ()
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. 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...
 
IDatabase $mDbSecondary
 
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
 
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...
 
mixed $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string $mIndexField
 The index to actually be used for ordering. More...
 
mixed $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
mixed $mPastTheEndIndex
 

Detailed Description

Definition at line 33 of file ContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ doBatchLookups()

ContribsPager::doBatchLookups ( )
protected

Definition at line 488 of file ContribsPager.php.

References Revision\getParentLengths(), isQueryableRange(), and 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

Definition at line 571 of file ContribsPager.php.

References $lang, IndexPager\$linkRenderer, ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), ContextSource\getContext(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), Linker\getRevDeleteLink(), ContextSource\getUser(), isQueryableRange(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), ContextSource\msg(), Title\newFromRow(), preventClickjacking(), Html\rawElement(), Linker\revComment(), ChangesList\revDateLink(), Hooks\run(), ChangesList\showCharacterDifference(), tryToCreateValidRevision(), Linker\userLink(), Linker\userTalkLink(), and wfDebug().

◆ getDefaultQuery()

ContribsPager::getDefaultQuery ( )

Definition at line 150 of file ContribsPager.php.

References $target.

◆ getEndBody()

ContribsPager::getEndBody ( )
protected
Returns
string

Definition at line 528 of file ContribsPager.php.

◆ getExtraSortFields()

ContribsPager::getExtraSortFields ( )
protected
Returns
string[]

Definition at line 467 of file ContribsPager.php.

References $target, getTargetTable(), and wfWarn().

◆ getIndexField()

ContribsPager::getIndexField ( )
Returns
string

Definition at line 415 of file ContribsPager.php.

References $target, getTargetTable(), and wfWarn().

Referenced by getQueryInfo(), and 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 379 of file ContribsPager.php.

References isQueryableRange(), and IP\parseRange().

Referenced by getQueryInfo(), and getTargetTable().

◆ getNamespace()

ContribsPager::getNamespace ( )
Returns
int|string

Definition at line 460 of file ContribsPager.php.

References $namespace.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )

Definition at line 349 of file ContribsPager.php.

Referenced by getQueryInfo().

◆ 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

Implements Pager.

Definition at line 164 of file ContribsPager.php.

References Html\rawElement().

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )
Returns
bool

Definition at line 772 of file ContribsPager.php.

References $preventClickjacking.

◆ getQueryInfo()

◆ getSqlComment()

ContribsPager::getSqlComment ( )

Overwrite Pager function and return a helpful comment.

Returns
string

Definition at line 756 of file ContribsPager.php.

◆ getStartBody()

ContribsPager::getStartBody ( )
protected
Returns
string

Definition at line 521 of file ContribsPager.php.

◆ getTagFilter()

ContribsPager::getTagFilter ( )
Returns
false|string

Definition at line 439 of file ContribsPager.php.

References $tagFilter.

◆ getTarget()

ContribsPager::getTarget ( )
Returns
string

Definition at line 446 of file ContribsPager.php.

References $target.

◆ 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 247 of file ContribsPager.php.

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

Referenced by getExtraSortFields(), and getIndexField().

◆ isNewOnly()

ContribsPager::isNewOnly ( )
Returns
bool

Definition at line 453 of file ContribsPager.php.

References $newOnly.

◆ 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 397 of file ContribsPager.php.

References ContextSource\getConfig(), IP\isIPv4(), IP\isIPv6(), and IP\parseCIDR().

Referenced by doBatchLookups(), formatRow(), and getIpRangeConds().

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )
protected

Definition at line 765 of file ContribsPager.php.

Referenced by formatRow().

◆ 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 782 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

Definition at line 179 of file ContribsPager.php.

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

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

Parameters
object$row
Title | null$title
Returns
Revision|null

Definition at line 540 of file ContribsPager.php.

References $title.

Referenced by formatRow().

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

◆ $deletedOnly

bool ContribsPager::$deletedOnly
private

Set to true to show only deleted revisions.

Definition at line 69 of file ContribsPager.php.

◆ $hideMinor

bool ContribsPager::$hideMinor
private

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

Definition at line 84 of file ContribsPager.php.

◆ $mDbSecondary

IDatabase ContribsPager::$mDbSecondary
private

Definition at line 89 of file ContribsPager.php.

◆ $messages

string [] ContribsPager::$messages
private

Local cache for escaped messages.

Definition at line 38 of file ContribsPager.php.

◆ $mParentLens

array ContribsPager::$mParentLens
private

Definition at line 94 of file ContribsPager.php.

◆ $namespace

string int ContribsPager::$namespace = ''
private

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

Definition at line 48 of file ContribsPager.php.

Referenced by getNamespace().

◆ $newOnly

bool ContribsPager::$newOnly
private

Set to true to show only new pages.

Definition at line 79 of file ContribsPager.php.

Referenced by isNewOnly().

◆ $nsInvert

bool ContribsPager::$nsInvert
private

Set to true to invert the namespace selection.

Definition at line 58 of file ContribsPager.php.

◆ $preventClickjacking

ContribsPager::$preventClickjacking = false
private

Definition at line 86 of file ContribsPager.php.

Referenced by getPreventClickjacking().

◆ $tagFilter

string false ContribsPager::$tagFilter
private

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

Definition at line 53 of file ContribsPager.php.

Referenced by getTagFilter().

◆ $target

string ContribsPager::$target
private

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

Definition at line 43 of file ContribsPager.php.

Referenced by getDefaultQuery(), getExtraSortFields(), getIndexField(), and getTarget().

◆ $templateParser

TemplateParser ContribsPager::$templateParser
private

Definition at line 99 of file ContribsPager.php.

◆ $topOnly

bool ContribsPager::$topOnly
private

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

current) revisions

Definition at line 74 of file ContribsPager.php.


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