MediaWiki  REL1_31
HistoryPager Class Reference
Inheritance diagram for HistoryPager:
Collaboration diagram for HistoryPager:

Public Member Functions

 __construct ( $historyPage, $year='', $month='', $tagFilter='', $conds=[])
 
 curLink ( $rev, $latest)
 Create a diff-to-current link for this revision for this page. More...
 
 diffButtons ( $rev, $firstInList)
 Create radio buttons for page history. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 formatRow ( $row)
 
 getArticle ()
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getPreventClickjacking ()
 Get the "prevent clickjacking" flag. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. 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...
 
 historyLine ( $row, $next, $notificationtimestamp=false, $latest=false, $firstInList=false)
 Returns a row from the history printout. More...
 
 lastLink ( $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 ( $rev)
 Create a link to view this revision of the page. More...
 
 submitButton ( $message, $attributes=[])
 Creates a submit button. More...
 
- Public Member Functions inherited from 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. More...
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=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...
 
 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...
 
 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...
 
 getResult ()
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 reallyDoQuery ( $offset, $limit, $descending)
 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)
 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
 
- Public Attributes inherited from ReverseChronologicalPager
 $mDay
 
 $mDefaultDirection = IndexPager::DIR_DESCENDING
 
 $mMonth
 
 $mYear
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
const DIR_DESCENDING = true
 

Protected Attributes

 $oldIdChecked
 
array $parentLens
 
 $preventClickjacking = false
 
bool $showTagEditUI
 Whether to show the tag editing UI. More...
 
- Protected Attributes inherited from IndexPager
 $mExtraSortFields
 An array of secondary columns to order by. More...
 
 $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
 $mIndexField
 The index to actually be used for ordering. More...
 
 $mLastShown
 
 $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 

Private Member Functions

 getRevisionButton ( $name, $msg)
 

Private Attributes

string $tagFilter
 

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...
 
- Protected Member Functions inherited from IndexPager
 buildQueryInfo ( $offset, $limit, $descending)
 Build variables to use by the database wrapper. 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 ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Detailed Description

Definition at line 375 of file HistoryAction.php.

Constructor & Destructor Documentation

◆ __construct()

HistoryPager::__construct (   $historyPage,
  $year = '',
  $month = '',
  $tagFilter = '',
  $conds = [] 
)
Parameters
HistoryAction$historyPage
string$year
string$month
string$tagFilter
array$conds

Definition at line 404 of file HistoryAction.php.

References $conds, $historyPage, $tagFilter, ReverseChronologicalPager\getDateCond(), ContextSource\getUser(), and ChangeTags\showTagEditingUI().

Member Function Documentation

◆ curLink()

HistoryPager::curLink (   $rev,
  $latest 
)

Create a diff-to-current link for this revision for this page.

Parameters
Revision$rev
bool$latestThis is the latest revision of the page?
Returns
string

Definition at line 834 of file HistoryAction.php.

References $rev, Revision\DELETED_TEXT, ContextSource\getTitle(), and ContextSource\getWikiPage().

Referenced by historyLine().

◆ diffButtons()

HistoryPager::diffButtons (   $rev,
  $firstInList 
)

Create radio buttons for page history.

Parameters
Revision$rev
bool$firstInListIs this version the first one?
Returns
string HTML output for the radio buttons

Definition at line 909 of file HistoryAction.php.

References $rev, Revision\DELETED_TEXT, Xml\element(), and IndexPager\getNumRows().

Referenced by historyLine().

◆ doBatchLookups()

HistoryPager::doBatchLookups ( )

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.

Returns
void

Reimplemented from IndexPager.

Definition at line 481 of file HistoryAction.php.

References $batch, as, Revision\getParentLengths(), NS_USER, NS_USER_TALK, of, or, and Hooks\run().

◆ formatRow()

HistoryPager::formatRow (   $row)
Parameters
stdClass$row
Returns
string

Reimplemented from IndexPager.

Definition at line 461 of file HistoryAction.php.

References IndexPager\$mIsFirst, $s, ContextSource\getConfig(), ContextSource\getTitle(), ContextSource\getUser(), and historyLine().

◆ getArticle()

HistoryPager::getArticle ( )

Definition at line 414 of file HistoryAction.php.

◆ getEndBody()

HistoryPager::getEndBody ( )

◆ getIndexField()

HistoryPager::getIndexField ( )

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=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.

Returns
string|array

Reimplemented from IndexPager.

Definition at line 453 of file HistoryAction.php.

◆ getPreventClickjacking()

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns
bool

Definition at line 962 of file HistoryAction.php.

References $preventClickjacking.

◆ getQueryInfo()

HistoryPager::getQueryInfo ( )

This function should be overridden to provide 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

Returns
array

Reimplemented from IndexPager.

Definition at line 426 of file HistoryAction.php.

References $revQuery, Revision\getQueryInfo(), ContextSource\getWikiPage(), ChangeTags\modifyDisplayQuery(), and Hooks\run().

◆ getRevisionButton()

HistoryPager::getRevisionButton (   $name,
  $msg 
)
private

Definition at line 558 of file HistoryAction.php.

References $name, Html\element(), ContextSource\msg(), preventClickjacking(), and text.

Referenced by getStartBody().

◆ getSqlComment()

HistoryPager::getSqlComment ( )

Get some text to go in brackets in the "function name" part of the SQL comment.

Returns
string

Reimplemented from IndexPager.

Definition at line 418 of file HistoryAction.php.

◆ getStartBody()

HistoryPager::getStartBody ( )

Creates begin of history list with a submit button.

Returns
string HTML output

Reimplemented from IndexPager.

Definition at line 512 of file HistoryAction.php.

References $buttons, $s, $user, ContextSource\getOutput(), getRevisionButton(), ContextSource\getTitle(), ContextSource\getUser(), Html\hidden(), ContextSource\msg(), Html\openElement(), submitButton(), Xml\tags(), text, Linker\tooltipAndAccesskeyAttribs(), and wfScript().

◆ historyLine()

HistoryPager::historyLine (   $row,
  $next,
  $notificationtimestamp = false,
  $latest = false,
  $firstInList = false 
)

Returns a row from the history printout.

Todo:
document some more, and maybe clean up the code (some params redundant?)
Parameters
stdClass$rowThe database row corresponding to the previous line.
mixed$nextThe database row corresponding to the next line (chronologically previous)
bool | string$notificationtimestamp
bool$latestWhether this row corresponds to the page's latest revision.
bool$firstInListWhether this row corresponds to the first displayed on this history page.
Returns
string HTML output for the row

Definition at line 640 of file HistoryAction.php.

References $attribs, $lang, $link, $query, $rev, $s, $user, Xml\check(), class, curLink(), Revision\DELETED_RESTRICTED, Revision\DELETED_TEXT, diffButtons(), ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), ContextSource\getContext(), ContextSource\getLanguage(), ContextSource\getTitle(), ContextSource\getUser(), lastLink(), list, ContextSource\msg(), preventClickjacking(), Html\rawElement(), Linker\revComment(), Linker\revDeleteLink(), Linker\revDeleteLinkDisabled(), revLink(), Linker\revUserTools(), Hooks\run(), ChangesList\showCharacterDifference(), Xml\tags(), text, and wfArrayFilterByKey().

Referenced by formatRow(), and getEndBody().

◆ lastLink()

HistoryPager::lastLink (   $prevRev,
  $next 
)

Create a diff-to-previous link for this revision for this page.

Parameters
Revision$prevRevThe revision being displayed
stdClass | string | null$nextThe next revision in list (that is the previous one in chronological order). May either be a row, "unknown" or null.
Returns
string

Definition at line 860 of file HistoryAction.php.

References $last, $linkRenderer, Revision\DELETED_TEXT, and ContextSource\getTitle().

Referenced by historyLine().

◆ preventClickjacking()

HistoryPager::preventClickjacking (   $enable = true)

This is called if a write operation is possible from the generated HTML.

Parameters
bool$enable

Definition at line 954 of file HistoryAction.php.

Referenced by getRevisionButton(), and historyLine().

◆ revLink()

HistoryPager::revLink (   $rev)

Create a link to view this revision of the page.

Parameters
Revision$rev
Returns
string

Definition at line 808 of file HistoryAction.php.

References $link, $rev, Revision\DELETED_TEXT, ContextSource\getLanguage(), and ContextSource\getTitle().

Referenced by historyLine().

◆ submitButton()

HistoryPager::submitButton (   $message,
  $attributes = [] 
)

Creates a submit button.

Parameters
string$messageText of the submit button, will be escaped
array$attributes
Returns
string HTML output for the submit button

Definition at line 617 of file HistoryAction.php.

References IndexPager\getNumRows(), and Html\submitButton().

Referenced by getStartBody().

Member Data Documentation

◆ $buttons

HistoryPager::$buttons

Definition at line 381 of file HistoryAction.php.

Referenced by getEndBody(), and getStartBody().

◆ $conds

HistoryPager::$conds

Definition at line 381 of file HistoryAction.php.

Referenced by __construct().

◆ $counter

HistoryPager::$counter

Definition at line 381 of file HistoryAction.php.

◆ $historyPage

HistoryPager::$historyPage

Definition at line 381 of file HistoryAction.php.

Referenced by __construct().

◆ $lastRow

bool stdClass HistoryPager::$lastRow = false

Definition at line 379 of file HistoryAction.php.

◆ $oldIdChecked

HistoryPager::$oldIdChecked
protected

Definition at line 383 of file HistoryAction.php.

◆ $parentLens

array HistoryPager::$parentLens
protected

Definition at line 389 of file HistoryAction.php.

◆ $preventClickjacking

HistoryPager::$preventClickjacking = false
protected

Definition at line 385 of file HistoryAction.php.

Referenced by getPreventClickjacking().

◆ $showTagEditUI

bool HistoryPager::$showTagEditUI
protected

Whether to show the tag editing UI.

Definition at line 392 of file HistoryAction.php.

◆ $tagFilter

string HistoryPager::$tagFilter
private

Definition at line 395 of file HistoryAction.php.

Referenced by __construct().


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