MediaWiki REL1_39
|
Efficient paging for SQL queries. More...
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, 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 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 () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
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 mOffset 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 IndexPager | |
IDatabase | $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) | |
Protected Member Functions | ||||
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.
| ||||
getHeaderRow (string $date) | ||||
getRow ( $row) | ||||
Get the HTML of a pager row.
| ||||
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 IndexPager | ||||
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | ||||
Generate (prev x| next x) (20|50|100...) type links for paging. | ||||
buildQueryInfo ( $offset, $limit, $order) | ||||
Build variables to use by the database wrapper. | ||||
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(). | ||||
getLimitLinks () | ||||
getLinkRenderer () | ||||
getPagingLinks ( $linkTexts, $disabledTexts=[]) | ||||
Get paging links. | ||||
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. | ||||
Additional Inherited Members | |
Static Protected Member Functions inherited from IndexPager | |
static | oppositeOrder ( $order) |
Protected Attributes inherited from 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 |
Efficient paging for SQL queries.
IndexPager with a formatted navigation bar.
Definition at line 29 of file ReverseChronologicalPager.php.
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.
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 in RangeChronologicalPager.
Definition at line 183 of file ReverseChronologicalPager.php.
Referenced by LogPager\__construct(), and HistoryPager\__construct().
|
finalprotected |
Get date from the timestamp.
string | $timestamp |
Definition at line 97 of file ReverseChronologicalPager.php.
References getUser().
|
protected |
End an existing group of page rows.
Definition at line 137 of file ReverseChronologicalPager.php.
|
protected |
Classes can extend to output a footer at the bottom of the pager list.
Reimplemented from IndexPager.
Definition at line 144 of file ReverseChronologicalPager.php.
|
protected |
ReverseChronologicalPager::getNavigationBar | ( | ) |
Implements Pager.
Definition at line 152 of file ReverseChronologicalPager.php.
Referenced by SpecialContributions\execute(), and ImageHistoryPseudoPager\getBody().
|
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.
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. |
Definition at line 228 of file ReverseChronologicalPager.php.
Referenced by RangeChronologicalPager\getDateCond(), and ContribsPager\processDateFilter().
|
protected |
Get the HTML of a pager row.
stdClass | $row |
Reimplemented from IndexPager.
Definition at line 104 of file ReverseChronologicalPager.php.
References $s.
|
protected |
Start a new group of page rows.
Definition at line 126 of file ReverseChronologicalPager.php.
|
finalprotected |
Determines whether the header row is the first that will be outputted to the page.
Definition at line 86 of file ReverseChronologicalPager.php.
|
protected |
Determines if a header row is needed based on the current state of the IndexPager.
string | $date | Formatted date header |
Definition at line 73 of file ReverseChronologicalPager.php.
int ReverseChronologicalPager::$mDay |
Definition at line 39 of file ReverseChronologicalPager.php.
Referenced by LogPager\getDay(), and LogPager\getDefaultQuery().
bool ReverseChronologicalPager::$mDefaultDirection = IndexPager::DIR_DESCENDING |
Definition at line 31 of file ReverseChronologicalPager.php.
bool ReverseChronologicalPager::$mGroupByDate = false |
Whether to group items by date.
Definition at line 33 of file ReverseChronologicalPager.php.
int ReverseChronologicalPager::$mMonth |
Definition at line 37 of file ReverseChronologicalPager.php.
Referenced by LogPager\getDefaultQuery(), and LogPager\getMonth().
int ReverseChronologicalPager::$mYear |
Definition at line 35 of file ReverseChronologicalPager.php.
Referenced by LogPager\getDefaultQuery(), and LogPager\getYear().