IndexPager with a formatted navigation bar. More...

Inherits MediaWiki\Pager\IndexPager.

Inherited by MediaWiki\Actions\Pager\HistoryPager, MediaWiki\Logging\Pager\LogPager, MediaWiki\Page\ImageHistoryPseudoPager, MediaWiki\Pager\RangeChronologicalPager, MediaWiki\Specials\Pager\MergeHistoryPager, and MediaWiki\Specials\Pager\NewPagesPager.

Collaboration diagram for MediaWiki\Pager\ReverseChronologicalPager:

[legend]

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 ()
	Get a configured navigation builder for this pager.

	getNumRows ()
	Get the number of rows in the result set.

	getOffset ()

	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.

	getQueryOrder ()

	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 null	$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	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$order	IndexPager::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

createNavigationBuilder ()

Create a new navigation builder instance.

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 ()

getOffsetCondsAndSortOptions ( $offset, int $limit, bool $order)

Get $conds and $options relevant for sorting.

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 null	$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 null	$mNavigationBar

string null	$mOrderType
	For pages that support multiple types of ordering, which one to use.

array	$mPastTheEndIndex

PagerNavigationBuilder	$navigationBuilder = null

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 21 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	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$order	IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING

Returns: array

Reimplemented from MediaWiki\Pager\IndexPager.

Reimplemented in MediaWiki\Pager\RangeChronologicalPager.

Definition at line 308 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	$year	Year up to which we want revisions
int	$month	Month 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 188 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Logging\Pager\LogPager\__construct(), and MediaWiki\Actions\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 99 of file ReverseChronologicalPager.php.

◆ 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 139 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 301 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 146 of file ReverseChronologicalPager.php.

◆ getHeaderRow()

MediaWiki\Pager\ReverseChronologicalPager::getHeaderRow ( string $date )

protected

Definition at line 37 of file ReverseChronologicalPager.php.

◆ getNavigationBar()

MediaWiki\Pager\ReverseChronologicalPager::getNavigationBar ( )

Stability: stable: to override

Returns: string HTML

Implements MediaWiki\Pager\Pager.

Definition at line 157 of file ReverseChronologicalPager.php.

Referenced by MediaWiki\Page\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	$year	Year up to which we want revisions
int	$month	Month up to which we want revisions
int	$day	[optional] Day up to which we want revisions. Default is end of month.