MediaWiki master
MediaWiki\Pager\RangeChronologicalPager Class Reference

Pager for filtering by a range of dates. More...

Inherits MediaWiki\Pager\ReverseChronologicalPager.

Inherited by MediaWiki\Pager\ContribsPager, and MediaWiki\Pager\NewFilesPager.

Collaboration diagram for MediaWiki\Pager\RangeChronologicalPager:

Public Member Functions

 getDateRangeCond ( $startTime, $endTime)
 Set and return a date range condition using timestamps provided by the user.
 
 getRangeOffsets ()
 Return the range of date offsets, in the format of [ endOffset, startOffset ].
 
- 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.
 
 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)
 

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

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

Detailed Description

Pager for filtering by a range of dates.

Stability: stable
to extend

Definition at line 32 of file RangeChronologicalPager.php.

Member Function Documentation

◆ buildQueryInfo()

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

Definition at line 103 of file RangeChronologicalPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\getTimestampField().

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

◆ getDateRangeCond()

MediaWiki\Pager\RangeChronologicalPager::getDateRangeCond (   $startTime,
  $endTime 
)

Set and return a date range condition using timestamps provided by the user.

We want the revisions between the two timestamps. Also supports only having a start or end timestamp. Assumes that the start timestamp comes before the end timestamp.

Stability: stable
to override
Parameters
string$startTimeTimestamp of the beginning of the date range (or empty)
string$endTimeTimestamp of the end of the date range (or empty)
Returns
array|null Database conditions to satisfy the specified date range or null if dates are invalid

Definition at line 56 of file RangeChronologicalPager.php.

References MediaWiki\Pager\RangeChronologicalPager\$rangeConds, and MediaWiki\Pager\ReverseChronologicalPager\getTimestampField().

Referenced by MediaWiki\Pager\ContribsPager\__construct(), and MediaWiki\Pager\NewFilesPager\__construct().

◆ getRangeOffsets()

MediaWiki\Pager\RangeChronologicalPager::getRangeOffsets ( )

Return the range of date offsets, in the format of [ endOffset, startOffset ].

Extensions can use this to get the range if they are not in the context of subclasses.

Since
1.40
Returns
string[]

Definition at line 96 of file RangeChronologicalPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\$endOffset, and MediaWiki\Pager\RangeChronologicalPager\$startOffset.

Member Data Documentation

◆ $rangeConds

string [] MediaWiki\Pager\RangeChronologicalPager::$rangeConds
protected
Deprecated:
since 1.40, use $startOffset and $endOffset instead.

Definition at line 38 of file RangeChronologicalPager.php.

Referenced by MediaWiki\Pager\RangeChronologicalPager\getDateRangeCond().

◆ $startOffset

string MediaWiki\Pager\RangeChronologicalPager::$startOffset
protected

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