MediaWiki master
MediaWiki\Pager\DeletedContribsPager Class Reference

Inherits MediaWiki\Pager\ContributionsPager.

Collaboration diagram for MediaWiki\Pager\DeletedContribsPager:

Public Member Functions

 __construct (HookContainer $hookContainer, LinkRenderer $linkRenderer, IConnectionProvider $dbProvider, RevisionStore $revisionStore, NamespaceInfo $namespaceInfo, CommentFormatter $commentFormatter, LinkBatchFactory $linkBatchFactory, UserFactory $userFactory, IContextSource $context, array $options, $target)
 
 getIndexField ()
 Returns the name of the index field.
 
- Public Member Functions inherited from MediaWiki\Pager\ContributionsPager
 __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.
 
 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.
 
- Public Member Functions inherited from MediaWiki\Pager\RangeChronologicalPager
 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 ].
 
- Public Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
 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.
 
- Public Member Functions inherited from MediaWiki\Pager\IndexPager
 __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.
 
 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.
 
- Public Member Functions inherited from MediaWiki\Context\ContextSource
 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)
 

Protected Member Functions

 getExtraSortFields ()
 
 getRevisionQuery ()
 Get queryInfo for the main query selecting revisions, not including filtering on namespace, date, etc.
Returns
array

 
- Protected Member Functions inherited from MediaWiki\Pager\ContributionsPager
 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.
Stability: stable
to override
Returns
string

 
 getEndBody ()
 Hook into getBody() for the end of the list.
Stability: stable
to override
Returns
string

 
 getNamespaceCond ()
 
 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.
Returns
string

 
 populateAttributes ( $row, &$attributes)
 Populate the HTML attributes.
 
 preventClickjacking ()
 
 setPreventClickjacking (bool $enable)
 
- Protected Member Functions inherited from MediaWiki\Pager\RangeChronologicalPager
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper.
Note
For b/c, query direction is true for ascending and false for descending
Stability: stable
to override
Parameters
int | string | null$offsetIndex offset, inclusive
int$limitExact query limit
bool$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
array

 
- Protected Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
 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.
Since
1.38
Returns
string

 
 getHeaderRow (string $date)
 
 getRow ( $row)
 Get the HTML of a pager row.
Stability: stable
to override
Since
1.38
Parameters
stdClass$row
Returns
string

 
 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.
 
- Protected Member Functions inherited from MediaWiki\Pager\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.
 
 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
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.
 
- Public Attributes inherited from MediaWiki\Pager\ContributionsPager
 $mGroupByDate = true
 
- Public Attributes inherited from MediaWiki\Pager\ReverseChronologicalPager
int $mDay
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 
bool $mGroupByDate = false
 Whether to group items by date.
 
int $mMonth
 
int $mYear
 
- Public Attributes inherited from MediaWiki\Pager\IndexPager
IReadableDatabase $mDb
 
bool $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)
 
- Static Protected Member Functions inherited from MediaWiki\Pager\IndexPager
static oppositeOrder ( $order)
 
- Protected Attributes inherited from MediaWiki\Pager\ContributionsPager
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'
 
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'
 
- Protected Attributes inherited from MediaWiki\Pager\RangeChronologicalPager
string[] $rangeConds
 
string $startOffset
 
- Protected Attributes inherited from MediaWiki\Pager\ReverseChronologicalPager
string $endOffset
 
- Protected Attributes inherited from MediaWiki\Pager\IndexPager
array $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 $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use.
 
array $mPastTheEndIndex
 

Detailed Description

Definition at line 38 of file DeletedContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\DeletedContribsPager::__construct ( HookContainer $hookContainer,
LinkRenderer $linkRenderer,
IConnectionProvider $dbProvider,
RevisionStore $revisionStore,
NamespaceInfo $namespaceInfo,
CommentFormatter $commentFormatter,
LinkBatchFactory $linkBatchFactory,
UserFactory $userFactory,
IContextSource $context,
array $options,
$target )
Parameters
HookContainer$hookContainer
LinkRenderer$linkRenderer
IConnectionProvider$dbProvider
RevisionStore$revisionStore
NamespaceInfo$namespaceInfo
CommentFormatter$commentFormatter
LinkBatchFactory$linkBatchFactory
UserFactory$userFactory
IContextSource$context
array$options
UserIdentity$target

Definition at line 52 of file DeletedContribsPager.php.

References MediaWiki\Pager\ContributionsPager\$namespaceInfo, MediaWiki\Pager\ContributionsPager\$revisionStore, and MediaWiki\Pager\ContributionsPager\$target.

Member Function Documentation

◆ getExtraSortFields()

MediaWiki\Pager\DeletedContribsPager::getExtraSortFields ( )
protected
Returns
string[]

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 105 of file DeletedContribsPager.php.

◆ getIndexField()

MediaWiki\Pager\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 MediaWiki\Pager\IndexPager.

Definition at line 109 of file DeletedContribsPager.php.

◆ getRevisionQuery()

MediaWiki\Pager\DeletedContribsPager::getRevisionQuery ( )
protected

Get queryInfo for the main query selecting revisions, not including filtering on namespace, date, etc.

Returns
array

Reimplemented from MediaWiki\Pager\ContributionsPager.

Definition at line 94 of file DeletedContribsPager.php.

References MediaWiki\Pager\IndexPager\getDatabase().


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