Efficient paging for SQL queries. More...

Inheritance diagram for ReverseChronologicalPager:

[legend]

Collaboration diagram for ReverseChronologicalPager:

[legend]

Public Member Functions
	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.

	getNavigationBar ()

Public Member Functions inherited from IndexPager
	__construct (IContextSource $context=null)

	doQuery ()
	Do the query, using information from the object context.

	extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this.

	formatRow ( $row)
	Abstract formatting function.

	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 ()
	This function should be overridden to return the name of the index fi- eld.

	getLimit ()
	Get the current limit.

	getLimitLinks ()

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

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links.

	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.

	getResult ()

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

	isNavigationBarShown ()
	Returns whether to show the "navigation bar".

	makeLink ( $text, array $query=null, $type=null)
	Make a self-link.

	reallyDoQuery ( $offset, $limit, $descending)
	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 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.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key)
	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 mOffset timestamp such that we can get all items with a timestamp up to the specified parameters.

Public Attributes
	$mDay

	$mDefaultDirection = IndexPager::DIR_DESCENDING

	$mMonth

	$mYear

Public Attributes inherited from IndexPager
	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

	$mDefaultLimit = 50

	$mIsBackwards

	$mIsFirst
	True if the current result set is the first one.

	$mIsLast

	$mLimit

	$mLimitsShown = [ 20, 50, 100, 250, 500 ]

	$mOffset

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

IResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Constants for the $mDefaultDirection field.

const	DIR_DESCENDING = true

Additional Inherited Members
Protected Member Functions inherited from IndexPager
	buildQueryInfo ( $offset, $limit, $descending)
	Build variables to use by the database wrapper.

	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.

	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 ()
	This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField().

	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start.

	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc.

Protected Attributes inherited from IndexPager
	$mDefaultQuery

	$mExtraSortFields
	An array of secondary columns to order by.

	$mFirstShown

	$mIncludeOffset = false
	Whether to include the offset in the query.

	$mIndexField
	The index to actually be used for ordering.

	$mLastShown

	$mNavigationBar

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

	$mPastTheEndIndex

Detailed Description

Efficient paging for SQL queries.

IndexPager with a formatted navigation bar.

Definition at line 28 of file ReverseChronologicalPager.php.

Member Function Documentation

◆ getDateCond()

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.

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

Reimplemented in RangeChronologicalPager.

Definition at line 73 of file ReverseChronologicalPager.php.

References $e, IndexPager\$mOffset, ContextSource\getConfig(), and getOffsetDate().

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

◆ getNavigationBar()

ReverseChronologicalPager::getNavigationBar ( )

Implements Pager.

Definition at line 34 of file ReverseChronologicalPager.php.

References IndexPager\$mNavigationBar, ContextSource\getLanguage(), IndexPager\getLimitLinks(), IndexPager\getPagingLinks(), IndexPager\isNavigationBarShown(), and ContextSource\msg().

Referenced by ImageHistoryPseudoPager\getBody().

◆ getOffsetDate()

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

static

Core logic of determining the mOffset 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 an 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.