MediaWiki master
MediaWiki\Pager\ReverseChronologicalPager Class Reference

IndexPager with a formatted navigation bar. More...

Inherits MediaWiki\Pager\IndexPager.

Inherited by ImageHistoryPseudoPager, MediaWiki\Pager\DeletedContribsPager, MediaWiki\Pager\HistoryPager, MediaWiki\Pager\LogPager, MediaWiki\Pager\MergeHistoryPager, MediaWiki\Pager\NewPagesPager, and MediaWiki\Pager\RangeChronologicalPager.

Collaboration diagram for MediaWiki\Pager\ReverseChronologicalPager:

Public Member Functions

 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.
 
 formatRow ( $row)
 Returns an HTML string representing the result row $row.
 
 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.
 
 getIndexField ()
 Returns the name of the index field.
 
 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.
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query.
 
 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)
 

Static Public Member Functions

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

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

 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
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called.
 
 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.
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows.
 
 getEndBody ()
 Hook into getBody() for the end of the list.
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField().
 
 getLinkRenderer ()
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment.
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start.
 
 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.
 

Protected Attributes

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

Detailed Description

IndexPager with a formatted navigation bar.

Stability: stable
to extend

Definition at line 34 of file ReverseChronologicalPager.php.

Member Function Documentation

◆ buildQueryInfo()

MediaWiki\Pager\ReverseChronologicalPager::buildQueryInfo (   $offset,
  $limit,
  $order 
)
protected

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

Reimplemented from MediaWiki\Pager\IndexPager.

Reimplemented in MediaWiki\Pager\RangeChronologicalPager.

Definition at line 324 of file ReverseChronologicalPager.php.

◆ getDateCond()

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.

Stability: stable
to override
Parameters
int$yearYear up to which we want revisions
int$monthMonth up to which we want revisions
int$day[optional] Day up to which we want revisions. Default is end of month.
Returns
string|null Timestamp or null if year and month are false/invalid

Definition at line 202 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Pager\LogPager\__construct(), and MediaWiki\Pager\HistoryPager\__construct().

◆ getDateFromTimestamp()

MediaWiki\Pager\ReverseChronologicalPager::getDateFromTimestamp ( string  $timestamp)
finalprotected

Get date from the timestamp.

Since
1.38
Parameters
string$timestamp
Returns
string Formatted date header

Definition at line 116 of file ReverseChronologicalPager.php.

References getUser().

◆ getEndGroup()

MediaWiki\Pager\ReverseChronologicalPager::getEndGroup ( )
protected

End an existing group of page rows.

Stability: stable
to override
Since
1.38
Returns
string

Definition at line 156 of file ReverseChronologicalPager.php.

◆ getEndOffset()

MediaWiki\Pager\ReverseChronologicalPager::getEndOffset ( )

Return the end offset, extensions can use this if they are not in the context of subclass.

Since
1.40
Returns
string

Definition at line 317 of file ReverseChronologicalPager.php.

◆ getFooter()

MediaWiki\Pager\ReverseChronologicalPager::getFooter ( )
protected

Classes can extend to output a footer at the bottom of the pager list.

Since
1.38
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 163 of file ReverseChronologicalPager.php.

◆ getHeaderRow()

MediaWiki\Pager\ReverseChronologicalPager::getHeaderRow ( string  $date)
protected
Parameters
string$date
Returns
string

Definition at line 54 of file ReverseChronologicalPager.php.

◆ getNavigationBar()

MediaWiki\Pager\ReverseChronologicalPager::getNavigationBar ( )
Stability: stable
to override
Returns
string HTML

Implements MediaWiki\Pager\Pager.

Definition at line 171 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Specials\SpecialContributions\execute(), and ImageHistoryPseudoPager\getBody().

◆ getOffsetDate()

static MediaWiki\Pager\ReverseChronologicalPager::getOffsetDate (   $year,
  $month,
  $day = -1 
)
static

Core logic of determining the offset timestamp such that we can get all items with a timestamp up to the specified parameters.

Given parameters for a day up to which to get items, this function finds the timestamp of the day just after the end of the range for use in a database strict inequality filter.

This is separate from getDateCond so we can use this logic in other places, such as in RangeChronologicalPager, where this function is used to convert year/month/day filter options into a timestamp.

Parameters
int$yearYear up to which we want revisions
int$monthMonth up to which we want revisions
int$day[optional] Day up to which we want revisions. Default is end of month.
Returns
MWTimestamp Timestamp or null if year and month are false/invalid

Definition at line 248 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Pager\ContribsPager\processDateFilter().

◆ getRow()

MediaWiki\Pager\ReverseChronologicalPager::getRow (   $row)
protected

Get the HTML of a pager row.

Stability: stable
to override
Since
1.38
Parameters
stdClass$row
Returns
string

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 123 of file ReverseChronologicalPager.php.

◆ getStartGroup()

MediaWiki\Pager\ReverseChronologicalPager::getStartGroup ( )
protected

Start a new group of page rows.

Stability: stable
to override
Since
1.38
Returns
string

Definition at line 145 of file ReverseChronologicalPager.php.

◆ getTimestampField()

MediaWiki\Pager\ReverseChronologicalPager::getTimestampField ( )

Returns the name of the timestamp field.

Subclass can override this to provide the timestamp field if they are using a aliased field for getIndexField()

Since
1.40
Returns
string

Definition at line 104 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Pager\RangeChronologicalPager\buildQueryInfo(), and MediaWiki\Pager\RangeChronologicalPager\getDateRangeCond().

◆ isFirstHeaderRow()

MediaWiki\Pager\ReverseChronologicalPager::isFirstHeaderRow ( )
finalprotected

Determines whether the header row is the first that will be outputted to the page.

Since
1.38
Returns
bool

Definition at line 93 of file ReverseChronologicalPager.php.

◆ isHeaderRowNeeded()

MediaWiki\Pager\ReverseChronologicalPager::isHeaderRowNeeded ( string  $date)
protected

Determines if a header row is needed based on the current state of the IndexPager.

Since
1.38
Parameters
string$dateFormatted date header
Returns
bool

Definition at line 80 of file ReverseChronologicalPager.php.

Member Data Documentation

◆ $endOffset

string MediaWiki\Pager\ReverseChronologicalPager::$endOffset
protected

◆ $mDay

int MediaWiki\Pager\ReverseChronologicalPager::$mDay

◆ $mDefaultDirection

bool MediaWiki\Pager\ReverseChronologicalPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Definition at line 36 of file ReverseChronologicalPager.php.

◆ $mGroupByDate

bool MediaWiki\Pager\ReverseChronologicalPager::$mGroupByDate = false

Whether to group items by date.

Definition at line 38 of file ReverseChronologicalPager.php.

◆ $mMonth

int MediaWiki\Pager\ReverseChronologicalPager::$mMonth

◆ $mYear

int MediaWiki\Pager\ReverseChronologicalPager::$mYear

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