MediaWiki
master
|
Public Member Functions | |
__construct (SpecialNewpages $form, GroupPermissionsLookup $groupPermissionsLookup, HookContainer $hookContainer, LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, NamespaceInfo $namespaceInfo, FormOptions $opts) | |
formatRow ( $row) | |
Returns an HTML string representing the result row $row. More... | |
getIndexField () | |
Returns the name of the index field. More... | |
getQueryInfo () | |
Provides all parameters needed for the main paged query. More... | |
![]() | |
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. More... | |
getEndOffset () | |
Return the end offset, extensions can use this if they are not in the context of subclass. More... | |
getNavigationBar () | |
getTimestampField () | |
Returns the name of the timestamp field. More... | |
![]() | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
doQuery () | |
Do the query, using information from the object context. 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... | |
getLimit () | |
Get the current limit. More... | |
getModuleStyles () | |
ResourceLoader modules that must be loaded to provide correct styling for this pager. More... | |
getNavigationBuilder () | |
@stable to override More... | |
getNumRows () | |
Get the number of rows in the result set. More... | |
getOffsetQuery () | |
Get the current offset for the URL query parameter. More... | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. More... | |
getResult () | |
getResultOffset () | |
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... | |
![]() | |
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... | |
getActionName () | |
Get the action name for the current web request. More... | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. More... | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
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 | ||||||||||
getEndBody () | ||||||||||
Hook into getBody() for the end of the list. More... | ||||||||||
getStartBody () | ||||||||||
Hook into getBody(), allows text to be inserted at the start. More... | ||||||||||
![]() | ||||||||||
buildQueryInfo ( $offset, $limit, $order) | ||||||||||
Build variables to use by the database wrapper.
| ||||||||||
getDateFromTimestamp (string $timestamp) | ||||||||||
Get date from the timestamp. More... | ||||||||||
getEndGroup () | ||||||||||
End an existing group of page rows. More... | ||||||||||
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. More... | ||||||||||
isFirstHeaderRow () | ||||||||||
Determines whether the header row is the first that will be outputted to the page. More... | ||||||||||
isHeaderRowNeeded (string $date) | ||||||||||
Determines if a header row is needed based on the current state of the IndexPager. More... | ||||||||||
![]() | ||||||||||
doBatchLookups () | ||||||||||
Called from getBody(), before getStartBody() is called and after doQuery() was called. 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... | ||||||||||
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... | ||||||||||
getExtraSortFields () | ||||||||||
Returns the names of secondary columns to order by in addition to the column in getIndexField(). More... | ||||||||||
getHookContainer () | ||||||||||
getLinkRenderer () | ||||||||||
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... | ||||||||||
preprocessResults ( $result) | ||||||||||
Pre-process results; useful for performing batch existence checks, etc. More... | ||||||||||
Protected Attributes | |
SpecialNewpages | $mForm |
FormOptions | $opts |
![]() | |
string | $endOffset |
![]() | |
array | $mDefaultQuery |
string[] | $mExtraSortFields |
An array of secondary columns to order by. More... | |
array | $mFirstShown |
bool | $mIncludeOffset = false |
Whether to include the offset in the query. More... | |
string string[] | $mIndexField |
The index to actually be used for ordering. More... | |
array | $mLastShown |
string | $mNavigationBar |
string null | $mOrderType |
For pages that support multiple types of ordering, which one to use. More... | |
array | $mPastTheEndIndex |
Additional Inherited Members | |
![]() | |
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. More... | |
![]() | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
bool | $mGroupByDate = false |
Whether to group items by date. More... | |
int | $mMonth |
int | $mYear |
![]() | |
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 | oppositeOrder ( $order) |
Definition at line 33 of file NewPagesPager.php.
NewPagesPager::__construct | ( | SpecialNewpages | $form, |
GroupPermissionsLookup | $groupPermissionsLookup, | ||
HookContainer | $hookContainer, | ||
LinkBatchFactory | $linkBatchFactory, | ||
ILoadBalancer | $loadBalancer, | ||
NamespaceInfo | $namespaceInfo, | ||
FormOptions | $opts | ||
) |
SpecialNewpages | $form | |
GroupPermissionsLookup | $groupPermissionsLookup | |
HookContainer | $hookContainer | |
LinkBatchFactory | $linkBatchFactory | |
ILoadBalancer | $loadBalancer | |
NamespaceInfo | $namespaceInfo | |
FormOptions | $opts |
Definition at line 66 of file NewPagesPager.php.
References $opts, DB_REPLICA, Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), and SpecialPage\getContext().
NewPagesPager::formatRow | ( | $row | ) |
Returns an HTML string representing the result row $row.
Rows will be concatenated and returned by getBody()
array | stdClass | $row | Database row |
Reimplemented from IndexPager.
Definition at line 202 of file NewPagesPager.php.
|
protected |
Hook into getBody() for the end of the list.
@stable to override
Reimplemented from IndexPager.
Definition at line 219 of file NewPagesPager.php.
NewPagesPager::getIndexField | ( | ) |
Returns the name of the index field.
If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=querykey will use indexfield to sort. In this case, the first returned key is the default.
Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.
The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).
Examples:
Reimplemented from IndexPager.
Definition at line 198 of file NewPagesPager.php.
NewPagesPager::getQueryInfo | ( | ) |
Provides all parameters needed for the main paged query.
It returns an associative array with the following elements: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => option array join_conds => JOIN conditions
Reimplemented from IndexPager.
Definition at line 86 of file NewPagesPager.php.
References RecentChange\getQueryInfo(), ChangeTags\modifyDisplayQuery(), NS_USER, and RecentChange\PRC_UNPATROLLED.
|
protected |
Hook into getBody(), allows text to be inserted at the start.
This will be called even if there are no rows in the result set.
Reimplemented from IndexPager.
Definition at line 206 of file NewPagesPager.php.
References NS_USER, and NS_USER_TALK.
|
protected |
Definition at line 43 of file NewPagesPager.php.
|
protected |
Definition at line 38 of file NewPagesPager.php.
Referenced by __construct().