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

Public Member Functions

 __construct (HistoryAction $historyPage, $year='', $month='', $tagFilter='', array $conds=[], $day='')
 
 curLink ( $rev)
 Create a diff-to-current link for this revision for this page. More...
 
 diffButtons ( $rev, $firstInList)
 Create radio buttons for page history. More...
 
 formatRow ( $row)
 
 getArticle ()
 
 getDefaultQuery ()
 
 getIndexField ()
 
 getPreventClickjacking ()
 Get the "prevent clickjacking" flag. More...
 
 getQueryInfo ()
 
 getSqlComment ()
 
 historyLine ( $row, $next, $notificationtimestamp=false, $dummy=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, 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)
 

Public Attributes

 $buttons
 
 $conds
 
 $counter
 
 $historyPage
 
bool stdClass $lastRow = false
 
- 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...
 

Protected Member Functions

 doBatchLookups ()
 
 getEndBody ()
 
 getStartBody ()
 Creates begin of history list with a submit button. 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...
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. 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

 $oldIdChecked
 
array $parentLens
 
 $preventClickjacking = false
 
bool $showTagEditUI
 Whether to show the tag editing UI. More...
 
- 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
 

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...
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Definition at line 31 of file HistoryPager.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 61 of file HistoryPager.php.

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

Member Function Documentation

◆ curLink()

HistoryPager::curLink (   $rev)

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

Parameters
Revision$rev
Returns
string

Definition at line 500 of file HistoryPager.php.

References IndexPager\getLinkRenderer(), ContextSource\getTitle(), ContextSource\getUser(), 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 578 of file HistoryPager.php.

References Xml\element(), and IndexPager\getNumRows().

Referenced by historyLine().

◆ doBatchLookups()

HistoryPager::doBatchLookups ( )
protected

Definition at line 143 of file HistoryPager.php.

References Revision\getParentLengths(), NS_USER, NS_USER_TALK, and Hooks\run().

◆ formatRow()

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

Definition at line 125 of file HistoryPager.php.

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

◆ getArticle()

HistoryPager::getArticle ( )

Definition at line 78 of file HistoryPager.php.

◆ getDefaultQuery()

HistoryPager::getDefaultQuery ( )

Definition at line 622 of file HistoryPager.php.

References IndexPager\$mDefaultQuery.

◆ getEndBody()

◆ getIndexField()

HistoryPager::getIndexField ( )

Definition at line 117 of file HistoryPager.php.

◆ getPreventClickjacking()

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns
bool

Definition at line 640 of file HistoryPager.php.

References $preventClickjacking.

◆ getQueryInfo()

HistoryPager::getQueryInfo ( )

◆ getRevisionButton()

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

Definition at line 227 of file HistoryPager.php.

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

Referenced by getStartBody().

◆ getSqlComment()

HistoryPager::getSqlComment ( )

Definition at line 82 of file HistoryPager.php.

◆ getStartBody()

HistoryPager::getStartBody ( )
protected

◆ historyLine()

HistoryPager::historyLine (   $row,
  $next,
  $notificationtimestamp = false,
  $dummy = 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$dummyUnused.
bool$firstInListWhether this row corresponds to the first displayed on this history page.
Returns
string HTML output for the row

Definition at line 307 of file HistoryPager.php.

References $lang, $s, Xml\check(), Html\closeElement(), curLink(), diffButtons(), ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), 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(), Hooks\run(), ChangesList\showCharacterDifference(), and Xml\tags().

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 529 of file HistoryPager.php.

References $last, IndexPager\$linkRenderer, IndexPager\getLinkRenderer(), 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 632 of file HistoryPager.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 489 of file HistoryPager.php.

References ContextSource\getLanguage(), ContextSource\getTitle(), ContextSource\getUser(), and ChangesList\revDateLink().

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 284 of file HistoryPager.php.

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

Referenced by getStartBody().

Member Data Documentation

◆ $buttons

HistoryPager::$buttons

Definition at line 37 of file HistoryPager.php.

Referenced by getEndBody(), and getStartBody().

◆ $conds

HistoryPager::$conds

Definition at line 37 of file HistoryPager.php.

Referenced by __construct().

◆ $counter

HistoryPager::$counter

Definition at line 37 of file HistoryPager.php.

◆ $historyPage

HistoryPager::$historyPage

Definition at line 37 of file HistoryPager.php.

Referenced by __construct().

◆ $lastRow

bool stdClass HistoryPager::$lastRow = false

Definition at line 35 of file HistoryPager.php.

◆ $oldIdChecked

HistoryPager::$oldIdChecked
protected

Definition at line 39 of file HistoryPager.php.

◆ $parentLens

array HistoryPager::$parentLens
protected

Definition at line 45 of file HistoryPager.php.

◆ $preventClickjacking

HistoryPager::$preventClickjacking = false
protected

Definition at line 41 of file HistoryPager.php.

Referenced by getPreventClickjacking().

◆ $showTagEditUI

bool HistoryPager::$showTagEditUI
protected

Whether to show the tag editing UI.

Definition at line 48 of file HistoryPager.php.

Referenced by getStartBody().

◆ $tagFilter

string HistoryPager::$tagFilter
private

Definition at line 51 of file HistoryPager.php.

Referenced by __construct().


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