MediaWiki
master
|
Public Member Functions | |
__construct (HistoryAction $historyPage, $year='', $month='', $tagFilter='', array $conds=[], $day='', LinkBatchFactory $linkBatchFactory=null, WatchlistNotificationManager $watchlistNotificationManager=null) | |
formatRow ( $row) | |
getArticle () | |
getDefaultQuery () | |
@inheritDoc More... | |
getIndexField () | |
Returns the name of the index field. More... | |
getPreventClickjacking () | |
Get the "prevent clickjacking" flag. More... | |
getQueryInfo () | |
Provides all parameters needed for the main paged query. More... | |
![]() | |
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 () | |
Stable to override. More... | |
![]() | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
Stable to call. More... | |
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... | |
getLimit () | |
Get the current limit. More... | |
getNumRows () | |
Get the number of rows in the result set. More... | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. More... | |
getResult () | |
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... | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
Stable to override. More... | |
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) | |
Public Attributes | |
$buttons | |
$conds | |
$counter | |
$historyPage | |
bool stdClass | $lastRow = false |
![]() | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
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... | |
Protected Member Functions | |
doBatchLookups () | |
Called from getBody(), before getStartBody() is called and after doQuery() was called. More... | |
getEmptyBody () | |
Returns message when query returns no revisions. More... | |
getEndBody () | |
Hook into getBody() for the end of the list. More... | |
getSqlComment () | |
Get some text to go in brackets in the "function name" part of the SQL comment. More... | |
getStartBody () | |
Creates begin of history list with a submit button. More... | |
![]() | |
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. More... | |
buildQueryInfo ( $offset, $limit, $order) | |
Build variables to use by the database wrapper. 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... | |
getExtraSortFields () | |
Returns the names of secondary columns to order by in addition to the column in getIndexField(). More... | |
getLimitLinks () | |
getLinkRenderer () | |
getPagingLinks ( $linkTexts, $disabledTexts=[]) | |
Get paging links. More... | |
isNavigationBarShown () | |
Returns whether to show the "navigation bar" @stable to override. 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 | |
$oldIdChecked | |
array | $parentLens |
$preventClickjacking = false | |
bool | $showTagEditUI |
Whether to show the tag editing UI. More... | |
![]() | |
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 |
Private Member Functions | |
curLink (RevisionRecord $rev) | |
Create a diff-to-current link for this revision for this page. More... | |
diffButtons (RevisionRecord $rev, $firstInList) | |
Create radio buttons for page history. More... | |
getRevisionButton ( $name, $msg) | |
historyLine ( $row, $next, $notificationtimestamp=false, $dummy=false, $firstInList=false) | |
Returns a row from the history printout. More... | |
lastLink (RevisionRecord $prevRev, $next) | |
Create a diff-to-previous link for this revision for this page. More... | |
preventClickjacking ( $enable=true) | |
This is called if a write operation is possible from the generated HTML. More... | |
revLink (RevisionRecord $rev) | |
Create a link to view this revision of the page. More... | |
submitButton ( $message, $attributes=[]) | |
Creates a submit button. More... | |
Private Attributes | |
LinkBatchFactory | $linkBatchFactory |
RevisionStore | $revisionStore |
string | $tagFilter |
WatchlistNotificationManager | $watchlistNotificationManager |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
static | oppositeOrder ( $order) |
Definition at line 34 of file HistoryPager.php.
HistoryPager::__construct | ( | HistoryAction | $historyPage, |
$year = '' , |
|||
$month = '' , |
|||
$tagFilter = '' , |
|||
array | $conds = [] , |
||
$day = '' , |
|||
LinkBatchFactory | $linkBatchFactory = null , |
||
WatchlistNotificationManager | $watchlistNotificationManager = null |
||
) |
HistoryAction | $historyPage | |
string | $year | |
string | $month | |
string | $tagFilter | |
array | $conds | |
string | $day | |
LinkBatchFactory | null | $linkBatchFactory | |
WatchlistNotificationManager | null | $watchlistNotificationManager |
Definition at line 75 of file HistoryPager.php.
References $conds, $historyPage, $linkBatchFactory, $tagFilter, $watchlistNotificationManager, ContextSource\getAuthority(), ReverseChronologicalPager\getDateCond(), and ChangeTags\showTagEditingUI().
|
private |
Create a diff-to-current link for this revision for this page.
RevisionRecord | $rev |
Definition at line 559 of file HistoryPager.php.
References Revision\RevisionRecord\getId(), IndexPager\getLinkRenderer(), ContextSource\getTitle(), ContextSource\getWikiPage(), and Revision\RevisionRecord\userCan().
Referenced by historyLine().
|
private |
Create radio buttons for page history.
RevisionRecord | $rev | |
bool | $firstInList | Is this version the first one? |
Definition at line 641 of file HistoryPager.php.
References Xml\element(), Revision\RevisionRecord\getId(), IndexPager\getNumRows(), and Revision\RevisionRecord\userCan().
Referenced by historyLine().
|
protected |
Called from getBody(), before getStartBody() is called and after doQuery() was called.
This will be called only if there are rows in the result set.
@stable to override
Reimplemented from IndexPager.
Definition at line 163 of file HistoryPager.php.
References NS_USER, and NS_USER_TALK.
HistoryPager::formatRow | ( | $row | ) |
stdClass | $row |
Reimplemented from IndexPager.
Definition at line 144 of file HistoryPager.php.
References $s, ContextSource\getConfig(), ContextSource\getTitle(), ContextSource\getUser(), and historyLine().
HistoryPager::getArticle | ( | ) |
Definition at line 99 of file HistoryPager.php.
HistoryPager::getDefaultQuery | ( | ) |
@inheritDoc
Reimplemented from IndexPager.
Definition at line 685 of file HistoryPager.php.
References IndexPager\$mDefaultQuery.
|
protected |
Returns message when query returns no revisions.
Reimplemented from IndexPager.
Definition at line 193 of file HistoryPager.php.
References ContextSource\msg().
|
protected |
Hook into getBody() for the end of the list.
@stable to override
Reimplemented from IndexPager.
Definition at line 270 of file HistoryPager.php.
References $buttons, IndexPager\$mPastTheEndRow, $s, ContextSource\getConfig(), IndexPager\getNumRows(), ContextSource\getTitle(), ContextSource\getUser(), and historyLine().
HistoryPager::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 136 of file HistoryPager.php.
HistoryPager::getPreventClickjacking | ( | ) |
Get the "prevent clickjacking" flag.
Definition at line 703 of file HistoryPager.php.
References $preventClickjacking.
HistoryPager::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 111 of file HistoryPager.php.
References $revQuery, ContextSource\getWikiPage(), and ChangeTags\modifyDisplayQuery().
|
private |
Definition at line 255 of file HistoryPager.php.
References Html\element(), ContextSource\msg(), and preventClickjacking().
Referenced by getStartBody().
|
protected |
Get some text to go in brackets in the "function name" part of the SQL comment.
Stable to override
Reimplemented from IndexPager.
Definition at line 103 of file HistoryPager.php.
|
protected |
Creates begin of history list with a submit button.
Reimplemented from IndexPager.
Definition at line 202 of file HistoryPager.php.
References $buttons, $s, ContextSource\getAuthority(), IndexPager\getNumRows(), ContextSource\getOutput(), getRevisionButton(), ContextSource\getTitle(), Html\hidden(), ContextSource\msg(), Html\openElement(), submitButton(), Xml\tags(), Linker\tooltipAndAccesskeyAttribs(), and wfScript().
|
private |
Returns a row from the history printout.
stdClass | $row | The database row corresponding to the previous line. |
mixed | $next | The database row corresponding to the next line (chronologically previous) |
bool | string | $notificationtimestamp | |
bool | $dummy | Unused. |
bool | $firstInList | Whether this row corresponds to the first displayed on this history page. |
Definition at line 338 of file HistoryPager.php.
References $lang, $s, Xml\check(), Html\closeElement(), curLink(), diffButtons(), ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), ContextSource\getAuthority(), ContextSource\getContext(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), ContextSource\getTitle(), ContextSource\getUser(), ContextSource\getWikiPage(), lastLink(), ContextSource\msg(), Html\openElement(), preventClickjacking(), Html\rawElement(), Linker\revComment(), Linker\revDeleteLink(), Linker\revDeleteLinkDisabled(), revLink(), Linker\revUserTools(), ChangesList\showCharacterDifference(), and Xml\tags().
Referenced by formatRow(), and getEndBody().
|
private |
Create a diff-to-previous link for this revision for this page.
RevisionRecord | $prevRev | The revision being displayed |
stdClass | string | null | $next | The next revision in list (that is the previous one in chronological order). May either be a row, "unknown" or null. |
Definition at line 588 of file HistoryPager.php.
References IndexPager\$linkRenderer, Revision\RevisionRecord\getId(), IndexPager\getLinkRenderer(), ContextSource\getTitle(), and Revision\RevisionRecord\userCan().
Referenced by historyLine().
|
private |
This is called if a write operation is possible from the generated HTML.
bool | $enable |
Definition at line 695 of file HistoryPager.php.
Referenced by getRevisionButton(), and historyLine().
|
private |
Create a link to view this revision of the page.
RevisionRecord | $rev |
Definition at line 548 of file HistoryPager.php.
References ContextSource\getLanguage(), ContextSource\getTitle(), ContextSource\getUser(), and ChangesList\revDateLink().
Referenced by historyLine().
|
private |
Creates a submit button.
string | $message | Text of the submit button, will be escaped |
array | $attributes |
Definition at line 315 of file HistoryPager.php.
References IndexPager\getNumRows(), and Html\submitButton().
Referenced by getStartBody().
HistoryPager::$buttons |
Definition at line 40 of file HistoryPager.php.
Referenced by getEndBody(), and getStartBody().
HistoryPager::$conds |
Definition at line 40 of file HistoryPager.php.
Referenced by __construct().
HistoryPager::$counter |
Definition at line 40 of file HistoryPager.php.
HistoryPager::$historyPage |
Definition at line 40 of file HistoryPager.php.
Referenced by __construct().
bool stdClass HistoryPager::$lastRow = false |
Definition at line 38 of file HistoryPager.php.
|
private |
Definition at line 63 of file HistoryPager.php.
Referenced by __construct().
|
protected |
Definition at line 42 of file HistoryPager.php.
|
protected |
Definition at line 48 of file HistoryPager.php.
|
protected |
Definition at line 44 of file HistoryPager.php.
Referenced by getPreventClickjacking().
|
private |
Definition at line 57 of file HistoryPager.php.
|
protected |
Whether to show the tag editing UI.
Definition at line 51 of file HistoryPager.php.
|
private |
Definition at line 54 of file HistoryPager.php.
Referenced by __construct().
|
private |
Definition at line 60 of file HistoryPager.php.
Referenced by __construct().