MediaWiki  1.30.0
ReverseChronologicalPager Class Reference

Efficient paging for SQL queries. More...

Inheritance diagram for ReverseChronologicalPager:
Collaboration diagram for ReverseChronologicalPager:

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. More...
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. More...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getResult ()
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 reallyDoQuery ( $offset, $limit, $descending)
 Do a query with specified parameters, rather than using the object context. More...
 
 setIncludeOffset ( $include)
 Set whether a row matching exactly the offset should be also included in the result or not. More...
 
 setLimit ( $limit)
 Set the limit from an other source than the request. More...
 
 setOffset ( $offset)
 Set the offset from an other source than the request. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

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. More...
 

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. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
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. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getExtraSortFields ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 
- Protected Attributes inherited from IndexPager
 $mExtraSortFields
 An array of secondary columns to order by. More...
 
 $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
 $mIndexField
 The index to actually be used for ordering. More...
 
 $mLastShown
 
 $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 

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

Reimplemented in RangeChronologicalPager.

Definition at line 73 of file ReverseChronologicalPager.php.

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

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

◆ getNavigationBar()

◆ 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$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 116 of file ReverseChronologicalPager.php.

References MWTimestamp\getInstance().

Referenced by getDateCond(), RangeChronologicalPager\getDateCond(), and ContribsPager\processDateFilter().

Member Data Documentation

◆ $mDay

ReverseChronologicalPager::$mDay

Definition at line 32 of file ReverseChronologicalPager.php.

◆ $mDefaultDirection

ReverseChronologicalPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Definition at line 29 of file ReverseChronologicalPager.php.

◆ $mMonth

ReverseChronologicalPager::$mMonth

Definition at line 31 of file ReverseChronologicalPager.php.

Referenced by LogPager\getDefaultQuery(), and LogPager\getMonth().

◆ $mYear

ReverseChronologicalPager::$mYear

Definition at line 30 of file ReverseChronologicalPager.php.

Referenced by LogPager\getDefaultQuery(), and LogPager\getYear().


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