MediaWiki master
MediaWiki\Pager\HistoryPager Class Reference

Inherits MediaWiki\Pager\ReverseChronologicalPager.

Collaboration diagram for MediaWiki\Pager\HistoryPager:

Public Member Functions

 __construct (HistoryAction $historyPage, $year=0, $month=0, $day=0, $tagFilter='', $tagInvert=false, array $conds=[], LinkBatchFactory $linkBatchFactory=null, WatchlistManager $watchlistManager=null, CommentFormatter $commentFormatter=null, HookContainer $hookContainer=null, ChangeTagsStore $changeTagsStore=null)
 
 formatRow ( $row)
 Returns a row from the history printout.
 
 getArticle ()
 
 getIndexField ()
 Returns the name of the index field.
 
 getPreventClickjacking ()
 Get the "prevent clickjacking" flag.
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query.
 
- 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.
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links.
 
 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 ()
 
 reallyDoQuery ( $offset, $limit, $order)
 Do a query with specified parameters, rather than using the object context.
 
 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)
 

Public Attributes

 $buttons
 
 $conds
 
 $historyPage
 
 $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)
 

Protected Member Functions

 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called.
 
 getEmptyBody ()
 Returns message when query returns no revisions.
 
 getEndBody ()
 Hook into getBody() for the end of the list.
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment.
 
 getStartBody ()
 Creates begin of history list with a submit button.
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar".
 
- Protected Member Functions inherited from MediaWiki\Pager\ReverseChronologicalPager
 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

 
 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.
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField().
 
 getLinkRenderer ()
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link.
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc.
 

Protected Attributes

 $oldIdChecked
 
array $parentLens
 
 $preventClickjacking = false
 
bool $showTagEditUI
 Whether to show the tag editing UI.
 
MapCacheLRU $tagsCache
 
- 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
 

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

Detailed Description

Definition at line 54 of file HistoryPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\HistoryPager::__construct ( HistoryAction $historyPage,
$year = 0,
$month = 0,
$day = 0,
$tagFilter = '',
$tagInvert = false,
array $conds = [],
LinkBatchFactory $linkBatchFactory = null,
WatchlistManager $watchlistManager = null,
CommentFormatter $commentFormatter = null,
HookContainer $hookContainer = null,
ChangeTagsStore $changeTagsStore = null )
Parameters
HistoryAction$historyPage
int$year
int$month
int$day
string$tagFilter
bool$tagInvert
array$conds
LinkBatchFactory | null$linkBatchFactory
WatchlistManager | null$watchlistManager
CommentFormatter | null$commentFormatter
HookContainer | null$hookContainer
ChangeTagsStore | null$changeTagsStore

Definition at line 113 of file HistoryPager.php.

References MediaWiki\Pager\HistoryPager\$conds, MediaWiki\Pager\HistoryPager\$historyPage, MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Pager\ReverseChronologicalPager\getDateCond(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Context\ContextSource\getTitle(), MediaWiki\Context\ContextSource\getUser(), ChangeTags\showTagEditingUI(), and MediaWiki\MainConfigNames\ShowUpdatedMarker.

Member Function Documentation

◆ doBatchLookups()

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

Stability: stable
to override
Returns
void

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 189 of file HistoryPager.php.

References MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\Context\ContextSource\getTitle(), NS_USER, and NS_USER_TALK.

◆ formatRow()

MediaWiki\Pager\HistoryPager::formatRow ( $row)

◆ getArticle()

MediaWiki\Pager\HistoryPager::getArticle ( )

Definition at line 149 of file HistoryPager.php.

◆ getEmptyBody()

MediaWiki\Pager\HistoryPager::getEmptyBody ( )
protected

Returns message when query returns no revisions.

Returns
string escaped message

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 234 of file HistoryPager.php.

References MediaWiki\Context\ContextSource\msg().

◆ getEndBody()

MediaWiki\Pager\HistoryPager::getEndBody ( )
protected

Hook into getBody() for the end of the list.

Stability: stable
to override
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 322 of file HistoryPager.php.

References MediaWiki\Pager\HistoryPager\$buttons, and MediaWiki\Pager\IndexPager\getNumRows().

◆ getIndexField()

MediaWiki\Pager\HistoryPager::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 185 of file HistoryPager.php.

◆ getPreventClickjacking()

MediaWiki\Pager\HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns
bool

Definition at line 671 of file HistoryPager.php.

References MediaWiki\Pager\HistoryPager\$preventClickjacking.

◆ getQueryInfo()

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

Definition at line 161 of file HistoryPager.php.

References MediaWiki\Context\ContextSource\getWikiPage().

◆ getSqlComment()

MediaWiki\Pager\HistoryPager::getSqlComment ( )
protected

Get some text to go in brackets in the "function name" part of the SQL comment.

Stability: stable
to override
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 153 of file HistoryPager.php.

◆ getStartBody()

MediaWiki\Pager\HistoryPager::getStartBody ( )
protected

◆ isNavigationBarShown()

MediaWiki\Pager\HistoryPager::isNavigationBarShown ( )
protected

Returns whether to show the "navigation bar".

Returns
bool

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 660 of file HistoryPager.php.

References MediaWiki\Pager\IndexPager\getNumRows().

Member Data Documentation

◆ $buttons

MediaWiki\Pager\HistoryPager::$buttons

◆ $conds

MediaWiki\Pager\HistoryPager::$conds

Definition at line 58 of file HistoryPager.php.

Referenced by MediaWiki\Pager\HistoryPager\__construct().

◆ $historyPage

MediaWiki\Pager\HistoryPager::$historyPage

Definition at line 58 of file HistoryPager.php.

Referenced by MediaWiki\Pager\HistoryPager\__construct().

◆ $mGroupByDate

MediaWiki\Pager\HistoryPager::$mGroupByDate = true

Definition at line 56 of file HistoryPager.php.

◆ $oldIdChecked

MediaWiki\Pager\HistoryPager::$oldIdChecked
protected

Definition at line 60 of file HistoryPager.php.

◆ $parentLens

array MediaWiki\Pager\HistoryPager::$parentLens
protected

Definition at line 66 of file HistoryPager.php.

◆ $preventClickjacking

MediaWiki\Pager\HistoryPager::$preventClickjacking = false
protected

◆ $showTagEditUI

bool MediaWiki\Pager\HistoryPager::$showTagEditUI
protected

Whether to show the tag editing UI.

Definition at line 69 of file HistoryPager.php.

◆ $tagsCache

MapCacheLRU MediaWiki\Pager\HistoryPager::$tagsCache
protected

Definition at line 71 of file HistoryPager.php.


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