MediaWiki
1.34.0
|
Pager for filtering by a range of dates. More...
Public Member Functions | |
getDateCond ( $year, $month, $day=-1) | |
Takes ReverseChronologicalPager::getDateCond parameters and repurposes them to work with timestamp-based getDateRangeCond. More... | |
getDateRangeCond ( $startStamp, $endStamp) | |
Set and return a date range condition using timestamps provided by the user. More... | |
Public Member Functions inherited from ReverseChronologicalPager | |
getNavigationBar () | |
Public Member Functions inherited from IndexPager | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
doQuery () | |
Do the query, using information from the object context. More... | |
extractResultInfo ( $isFirst, $limit, IResultWrapper $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, $order) | |
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 () | |
getContext () | |
Get the base IContextSource object. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. More... | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() More... | |
setContext (IContextSource $context) | |
Protected Member Functions | |
buildQueryInfo ( $offset, $limit, $order) | |
Build variables to use by the database wrapper. More... | |
Protected Member Functions inherited from IndexPager | |
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. 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... | |
getLinkRenderer () | |
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 | |
string[] | $rangeConds = [] |
Protected Attributes inherited from IndexPager | |
array | $mDefaultQuery |
string[] | $mExtraSortFields |
An array of secondary columns to order by. More... | |
mixed | $mFirstShown |
bool | $mIncludeOffset = false |
Whether to include the offset in the query. More... | |
string | $mIndexField |
The index to actually be used for ordering. More... | |
mixed | $mLastShown |
string | $mNavigationBar |
string null | $mOrderType |
For pages that support multiple types of ordering, which one to use. More... | |
mixed | $mPastTheEndIndex |
Additional Inherited Members | |
Static Public Member Functions inherited from ReverseChronologicalPager | |
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 inherited from ReverseChronologicalPager | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
int | $mMonth |
int | $mYear |
Public Attributes inherited from IndexPager | |
IDatabase | $mDb |
bool | $mDefaultDirection |
$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More... | |
int | $mDefaultLimit = 50 |
The default entry limit choosen for clients. More... | |
bool | $mIsBackwards |
bool | $mIsFirst |
True if the current result set is the first one. More... | |
bool | $mIsLast |
int | $mLimit |
The maximum number of entries to show. More... | |
int[] | $mLimitsShown = [ 20, 50, 100, 250, 500 ] |
List of default entry limit options to be presented to clients. More... | |
mixed | $mOffset |
The starting point to enumerate entries. More... | |
stdClass bool null | $mPastTheEndRow |
Extra row fetched at the end to see if the end was reached. More... | |
bool | $mQueryDone = false |
Whether the listing query completed. More... | |
WebRequest | $mRequest |
IResultWrapper | $mResult |
Result object for the query. More... | |
const | DIR_ASCENDING = false |
Backwards-compatible constant for $mDefaultDirection field (do not change) More... | |
const | DIR_DESCENDING = true |
Backwards-compatible constant for $mDefaultDirection field (do not change) More... | |
const | QUERY_ASCENDING = true |
Backwards-compatible constant for reallyDoQuery() (do not change) More... | |
const | QUERY_DESCENDING = false |
Backwards-compatible constant for reallyDoQuery() (do not change) More... | |
Static Protected Member Functions inherited from IndexPager | |
static | oppositeOrder ( $order) |
Pager for filtering by a range of dates.
Definition at line 27 of file RangeChronologicalPager.php.
|
protected |
Build variables to use by the database wrapper.
string | $offset | Index offset, inclusive |
int | $limit | Exact query limit |
bool | $order | IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING |
Reimplemented from IndexPager.
Definition at line 100 of file RangeChronologicalPager.php.
Referenced by ContribsPager\reallyDoQuery().
RangeChronologicalPager::getDateCond | ( | $year, | |
$month, | |||
$day = -1 |
|||
) |
Takes ReverseChronologicalPager::getDateCond parameters and repurposes them to work with timestamp-based getDateRangeCond.
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. |
Reimplemented from ReverseChronologicalPager.
Definition at line 80 of file RangeChronologicalPager.php.
References IndexPager\$mOffset, getDateRangeCond(), and ReverseChronologicalPager\getOffsetDate().
RangeChronologicalPager::getDateRangeCond | ( | $startStamp, | |
$endStamp | |||
) |
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.
string | $startStamp | Timestamp of the beginning of the date range (or empty) |
string | $endStamp | Timestamp of the end of the date range (or empty) |
Definition at line 43 of file RangeChronologicalPager.php.
References $rangeConds, and MWTimestamp\getInstance().
Referenced by NewFilesPager\__construct(), ContribsPager\__construct(), and getDateCond().
|
protected |
Definition at line 30 of file RangeChronologicalPager.php.
Referenced by getDateRangeCond().