Inheritance diagram for HistoryPager:

[legend]

Collaboration diagram for HistoryPager:

[legend]

Public Member Functions
	__construct (HistoryAction $historyPage, $year='', $month='', $tagFilter='', array $conds=[], $day='', LinkBatchFactory $linkBatchFactory=null, WatchlistManager $watchlistManager=null, CommentFormatter $commentFormatter=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...

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...

	getBody ()
	Get the formatted result list. More...

	getDatabase ()
	Get the Database object in use. More...

	getLimit ()
	Get the current limit. More...

	getModuleStyles ()
	ResourceLoader modules that must be loaded to provide correct styling for this pager. 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 ()

	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...

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...

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object. More...

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens. 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

	$lastResultOffset = false

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 ()
	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...

	isNavigationBarShown ()
	Returns whether to show the "navigation bar". 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...

	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...

	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...

Protected Attributes inherited from IndexPager
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, $firstInList, $resultOffset)
	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...

	revLink (RevisionRecord $rev)
	Create a link to view this revision of the page. More...

	setPreventClickjacking (bool $flag)
	Set the "prevent clickjacking" flag; for example if a write operation if possible from the generated HTML. More...

	submitButton ( $message, $attributes=[])
	Creates a submit button. More...

Private Attributes
CommentFormatter	$commentFormatter

string[]	$formattedComments = []
	Formatted comments, with the key being their result offset as for $revisions. More...

LinkBatchFactory	$linkBatchFactory

RevisionRecord[]	$revisions = []
	Revisions, with the key being their result offset. More...

RevisionStore	$revisionStore

string	$tagFilter

WatchlistManager	$watchlistManager

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

Constructor & Destructor Documentation

◆ __construct()

HistoryPager::__construct	(	HistoryAction	$historyPage,
			$year = `''`,
			$month = `''`,
			$tagFilter = `''`,
		array	$conds = `[]`,
			$day = `''`,
		LinkBatchFactory	$linkBatchFactory = `null`,
		WatchlistManager	$watchlistManager = `null`,
		CommentFormatter	$commentFormatter = `null`
	)

Parameters

HistoryAction	$historyPage
string	$year
string	$month
string	$tagFilter
array	$conds
string	$day
LinkBatchFactory \| null	$linkBatchFactory
WatchlistManager \| null	$watchlistManager
CommentFormatter \| null	$commentFormatter

Definition at line 91 of file HistoryPager.php.

References $commentFormatter, $conds, $historyPage, $linkBatchFactory, $tagFilter, $watchlistManager, ContextSource\getAuthority(), ReverseChronologicalPager\getDateCond(), and ChangeTags\showTagEditingUI().

Member Function Documentation

◆ curLink()

HistoryPager::curLink ( RevisionRecord $rev )

private

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

Parameters

RevisionRecord $rev

Returns: string

Definition at line 586 of file HistoryPager.php.

References MediaWiki\Revision\RevisionRecord\getId(), IndexPager\getLinkRenderer(), ContextSource\getTitle(), ContextSource\getWikiPage(), and MediaWiki\Revision\RevisionRecord\userCan().

Referenced by historyLine().

◆ diffButtons()

HistoryPager::diffButtons	(	RevisionRecord	$rev,
			$firstInList
	)

private

Create radio buttons for page history.

Parameters

RevisionRecord	$rev
bool	$firstInList	Is this version the first one?

Returns: string HTML output for the radio buttons

Definition at line 668 of file HistoryPager.php.

References Xml\element(), MediaWiki\Revision\RevisionRecord\getId(), IndexPager\getNumRows(), and MediaWiki\Revision\RevisionRecord\userCan().

Referenced by historyLine().

◆ doBatchLookups()

HistoryPager::doBatchLookups ( )

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

Returns: void

Reimplemented from IndexPager.

Definition at line 188 of file HistoryPager.php.

References $title, ContextSource\getAuthority(), ContextSource\getTitle(), NS_USER, and NS_USER_TALK.

◆ formatRow()

HistoryPager::formatRow ( $row )

Parameters

stdClass $row

Returns: string

Reimplemented from IndexPager.

Definition at line 167 of file HistoryPager.php.

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

◆ getArticle()

HistoryPager::getArticle ( )

Definition at line 117 of file HistoryPager.php.

◆ getDefaultQuery()

HistoryPager::getDefaultQuery ( )

@inheritDoc

Reimplemented from IndexPager.

Definition at line 726 of file HistoryPager.php.

References IndexPager\$mDefaultQuery.

◆ getEmptyBody()

HistoryPager::getEmptyBody ( )

protected

Returns message when query returns no revisions.

Returns: string escaped message

Reimplemented from IndexPager.

Definition at line 233 of file HistoryPager.php.

References ContextSource\msg().

◆ getEndBody()

HistoryPager::getEndBody ( )

protected

Hook into getBody() for the end of the list.

@stable to override

Returns: string

Reimplemented from IndexPager.

Definition at line 310 of file HistoryPager.php.

References $buttons, IndexPager\$mPastTheEndRow, $s, ContextSource\getConfig(), IndexPager\getNumRows(), ContextSource\getTitle(), ContextSource\getUser(), and historyLine().

◆ getIndexField()

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:

Always paginate on the user field: 'user'
Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]

Returns: string|string[]|array[]

Reimplemented from IndexPager.

Definition at line 159 of file HistoryPager.php.

◆ getPreventClickjacking()

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns: bool

Definition at line 745 of file HistoryPager.php.

References $preventClickjacking.

◆ getQueryInfo()

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

Returns: array

Reimplemented from IndexPager.

Definition at line 129 of file HistoryPager.php.

References $revQuery, ContextSource\getWikiPage(), and ChangeTags\modifyDisplayQuery().

◆ getRevisionButton()

HistoryPager::getRevisionButton	(	$name,
		$msg
	)

private

Definition at line 295 of file HistoryPager.php.

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

Referenced by getStartBody().

◆ getSqlComment()

HistoryPager::getSqlComment ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from IndexPager.

Definition at line 121 of file HistoryPager.php.

◆ getStartBody()

HistoryPager::getStartBody ( )

protected

Creates begin of history list with a submit button.

Returns: string HTML output

Reimplemented from IndexPager.

Definition at line 242 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().

◆ historyLine()

HistoryPager::historyLine	(	$row,
		$next,
		$notificationtimestamp,
		$firstInList,
		$resultOffset
	)

private

Returns a row from the history printout.

Todo:: document some more, and maybe clean up the code (some params redundant?)

Parameters

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	$firstInList	Whether this row corresponds to the first displayed on this history page.
int	$resultOffset	The offset into the current result set

Returns: string HTML output for the row

Definition at line 379 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(), Html\rawElement(), Linker\revDeleteLink(), Linker\revDeleteLinkDisabled(), revLink(), Linker\revUserTools(), setPreventClickjacking(), ChangesList\showCharacterDifference(), and Xml\tags().

Referenced by formatRow(), and getEndBody().

◆ isNavigationBarShown()

HistoryPager::isNavigationBarShown ( )

protected

Returns whether to show the "navigation bar".

Returns: bool

Reimplemented from IndexPager.

Definition at line 716 of file HistoryPager.php.

References IndexPager\getNumRows().

◆ lastLink()

HistoryPager::lastLink	(	RevisionRecord	$prevRev,
			$next
	)

private

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

Parameters

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.

Returns: string

Definition at line 615 of file HistoryPager.php.

References IndexPager\$linkRenderer, MediaWiki\Revision\RevisionRecord\getId(), IndexPager\getLinkRenderer(), ContextSource\getTitle(), and MediaWiki\Revision\RevisionRecord\userCan().

Referenced by historyLine().

◆ revLink()

HistoryPager::revLink ( RevisionRecord $rev )

private

Create a link to view this revision of the page.

Parameters

RevisionRecord $rev

Returns: string

Definition at line 575 of file HistoryPager.php.

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

Referenced by historyLine().

◆ setPreventClickjacking()

HistoryPager::setPreventClickjacking ( bool $flag )

private

Set the "prevent clickjacking" flag; for example if a write operation if possible from the generated HTML.

Parameters

bool $flag

Definition at line 737 of file HistoryPager.php.

Referenced by getRevisionButton(), and historyLine().

◆ submitButton()

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

private

Creates a submit button.

Parameters

string	$message	Text of the submit button, will be escaped
array	$attributes

Returns: string HTML output for the submit button

Definition at line 356 of file HistoryPager.php.

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

Referenced by getStartBody().

Member Data Documentation

◆ $buttons

HistoryPager::$buttons

Definition at line 42 of file HistoryPager.php.

Referenced by getEndBody(), and getStartBody().

◆ $commentFormatter

CommentFormatter HistoryPager::$commentFormatter

private

Definition at line 68 of file HistoryPager.php.

Referenced by __construct().

◆ $conds

HistoryPager::$conds

Definition at line 42 of file HistoryPager.php.

Referenced by __construct().

◆ $counter

HistoryPager::$counter

Definition at line 42 of file HistoryPager.php.

◆ $formattedComments

string [] HistoryPager::$formattedComments = []

private

Formatted comments, with the key being their result offset as for $revisions.

Definition at line 78 of file HistoryPager.php.

◆ $historyPage

HistoryPager::$historyPage

Definition at line 42 of file HistoryPager.php.

Referenced by __construct().

◆ $lastResultOffset

HistoryPager::$lastResultOffset = false

Definition at line 40 of file HistoryPager.php.

◆ $lastRow

bool stdClass HistoryPager::$lastRow = false

Definition at line 39 of file HistoryPager.php.

◆ $linkBatchFactory

LinkBatchFactory HistoryPager::$linkBatchFactory

private

Definition at line 65 of file HistoryPager.php.

Referenced by __construct().

◆ $oldIdChecked

HistoryPager::$oldIdChecked

protected

Definition at line 44 of file HistoryPager.php.

◆ $parentLens

array HistoryPager::$parentLens

protected

Definition at line 50 of file HistoryPager.php.

◆ $preventClickjacking

HistoryPager::$preventClickjacking = false

protected

Definition at line 46 of file HistoryPager.php.

Referenced by getPreventClickjacking().

◆ $revisions

RevisionRecord [] HistoryPager::$revisions = []

private

Revisions, with the key being their result offset.

Definition at line 73 of file HistoryPager.php.

◆ $revisionStore

RevisionStore HistoryPager::$revisionStore

private

Definition at line 59 of file HistoryPager.php.

◆ $showTagEditUI

bool HistoryPager::$showTagEditUI

protected

Whether to show the tag editing UI.

Definition at line 53 of file HistoryPager.php.

◆ $tagFilter

string HistoryPager::$tagFilter

private

Definition at line 56 of file HistoryPager.php.

Referenced by __construct().

◆ $watchlistManager

WatchlistManager HistoryPager::$watchlistManager

private

Definition at line 62 of file HistoryPager.php.

Referenced by __construct().

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

includes/actions/pagers/HistoryPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ curLink()

◆ diffButtons()

◆ doBatchLookups()

◆ formatRow()

◆ getArticle()

◆ getDefaultQuery()

◆ getEmptyBody()

◆ getEndBody()

◆ getIndexField()

◆ getPreventClickjacking()

◆ getQueryInfo()

◆ getRevisionButton()

◆ getSqlComment()

◆ getStartBody()

◆ historyLine()

◆ isNavigationBarShown()

◆ lastLink()

◆ revLink()

◆ setPreventClickjacking()

◆ submitButton()

Member Data Documentation

◆ $buttons

◆ $commentFormatter

◆ $conds

◆ $counter

◆ $formattedComments

◆ $historyPage

◆ $lastResultOffset

◆ $lastRow

◆ $linkBatchFactory

◆ $oldIdChecked

◆ $parentLens

◆ $preventClickjacking

◆ $revisions

◆ $revisionStore

◆ $showTagEditUI

◆ $tagFilter

◆ $watchlistManager