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

Public Member Functions

 __construct (IContextSource $context, CommentStore $commentStore, HookContainer $hookContainer, LinkRenderer $linkRenderer, ILoadBalancer $loadBalancer, RevisionFactory $revisionFactory, $target, $namespace)
 
 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 ()
 Returns the name of the index field. More...
 
 getNamespace ()
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query. More...
 
 getTarget ()
 
 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...
 
- 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...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getLimit ()
 Get the current limit. More...
 
 getModuleStyles ()
 ResourceLoader modules that must be loaded to provide correct styling for this pager. More...
 
 getNavigationBuilder ()
 @stable to override More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getOffsetQuery ()
 Get the current offset for the URL query parameter. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 getResultOffset ()
 
 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...
 
 getActionName ()
 Get the action name for the current web request. More...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 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)
 

Public Attributes

string[] $messages
 Local cache for escaped messages. More...
 
 $mGroupByDate = true
 
string int $namespace = ''
 A single namespace number, or an empty string for all namespaces. More...
 
string $target
 User name, or a string describing an IP address range. More...
 
- Public Attributes inherited from ReverseChronologicalPager
int $mDay
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 
bool $mGroupByDate = false
 Whether to group items by date. More...
 
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...
 

Protected Member Functions

 getEndBody ()
 Hook into getBody() for the end of the list.@stable to override
Returns
string
More...
 
 getExtraSortFields ()
 
 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
More...
 
- Protected Member Functions inherited from ReverseChronologicalPager
 getDateFromTimestamp (string $timestamp)
 Get date from the timestamp. More...
 
 getEndGroup ()
 End an existing group of page rows. More...
 
 getFooter ()
 Classes can extend to output a footer at the bottom of the pager list.
Since
1.38
Returns
string
More...
 
 getHeaderRow (string $date)
 
 getRow ( $row)
 Get the HTML of a pager row.
Stability: stable
to override
Since
1.38
Parameters
stdClass$row
Returns
string
More...
 
 getStartGroup ()
 Start a new group of page rows. More...
 
 isFirstHeaderRow ()
 Determines whether the header row is the first that will be outputted to the page. More...
 
 isHeaderRowNeeded (string $date)
 Determines if a header row is needed based on the current state of the IndexPager. 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...
 
 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...
 
 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...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Additional Inherited Members

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

Definition at line 34 of file DeletedContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

DeletedContribsPager::__construct ( IContextSource  $context,
CommentStore  $commentStore,
HookContainer  $hookContainer,
LinkRenderer  $linkRenderer,
ILoadBalancer  $loadBalancer,
RevisionFactory  $revisionFactory,
  $target,
  $namespace 
)
Parameters
IContextSource$context
CommentStore$commentStore
HookContainer$hookContainer
LinkRenderer$linkRenderer
ILoadBalancer$loadBalancer
RevisionFactory$revisionFactory
string$target
string | int$namespace

Definition at line 72 of file DeletedContribsPager.php.

References $target, DB_REPLICA, Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), and ContextSource\msg().

Member Function Documentation

◆ formatRow()

DeletedContribsPager::formatRow (   $row)

Generates each row in the contributions list.

Todo:
This would probably look a lot nicer in a table.
Parameters
stdClass$row
Returns
string

Reimplemented from IndexPager.

Definition at line 232 of file DeletedContribsPager.php.

References Html\rawElement(), and wfDebug().

◆ getDefaultQuery()

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

@stable to override

Returns
array Associative array

Reimplemented from IndexPager.

Definition at line 96 of file DeletedContribsPager.php.

References $target.

◆ getEndBody()

DeletedContribsPager::getEndBody ( )
protected

Hook into getBody() for the end of the list.@stable to override

Returns
string

Reimplemented from IndexPager.

Definition at line 213 of file DeletedContribsPager.php.

◆ getExtraSortFields()

DeletedContribsPager::getExtraSortFields ( )
protected
Returns
string[]

Reimplemented from IndexPager.

Definition at line 181 of file DeletedContribsPager.php.

◆ getIndexField()

DeletedContribsPager::getIndexField ( )

Returns the name of the index field.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=querykey will use indexfield to sort. In this case, the first returned key is the default.

Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.

The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).

Examples:

  • Always paginate on the user field: 'user'
  • Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
  • Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
  • Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]
Returns
string|string[]|array[]

Reimplemented from IndexPager.

Definition at line 185 of file DeletedContribsPager.php.

Referenced by reallyDoQuery().

◆ getNamespace()

DeletedContribsPager::getNamespace ( )
Returns
int|string

Definition at line 199 of file DeletedContribsPager.php.

◆ getQueryInfo()

DeletedContribsPager::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 103 of file DeletedContribsPager.php.

References $dbr, $target, ContextSource\getAuthority(), IndexPager\getDatabase(), and ChangeTags\modifyDisplayQuery().

◆ getStartBody()

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

Definition at line 206 of file DeletedContribsPager.php.

◆ getTarget()

DeletedContribsPager::getTarget ( )
Returns
string

Definition at line 192 of file DeletedContribsPager.php.

◆ reallyDoQuery()

DeletedContribsPager::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 144 of file DeletedContribsPager.php.

References getIndexField().

Member Data Documentation

◆ $messages

string [] DeletedContribsPager::$messages

Local cache for escaped messages.

Definition at line 41 of file DeletedContribsPager.php.

◆ $mGroupByDate

DeletedContribsPager::$mGroupByDate = true

Definition at line 36 of file DeletedContribsPager.php.

◆ $namespace

string int DeletedContribsPager::$namespace = ''

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

Definition at line 51 of file DeletedContribsPager.php.

◆ $target

string DeletedContribsPager::$target

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

Definition at line 46 of file DeletedContribsPager.php.

Referenced by __construct(), getDefaultQuery(), and getQueryInfo().


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