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

	formatRow ($row)

	getArticle ()

	getEndBody ()

	getIndexField ()

	getPreventClickjacking ()
	Get the "prevent clickjacking" flag. More...

	getQueryInfo ()

	getSqlComment ()

	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, ResultWrapper $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, $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 ()
	Get the Config object. More...

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

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getStats ()
	Get the Stats object. More...

	getTiming ()
	Get the Timing object. More...

	getTitle ()
	Get the Title object. More...

	getUser ()
	Get the User object. More...

	getWikiPage ()
	Get the WikiPage object. More...

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)
	Set the IContextSource object. More...

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

ResultWrapper	$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)

Additional Inherited Members
Protected Member Functions inherited from IndexPager
	buildQueryInfo ($offset, $limit, $descending)
	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...

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

Detailed Description

Definition at line 364 of file HistoryAction.php.

Constructor & Destructor Documentation

HistoryPager::__construct	(	$historyPage,
		$year = `''`,
		$month = `''`,
		$tagFilter = `''`,
		$conds = `[]`
	)

Parameters

HistoryAction	$historyPage
string	$year
string	$month
string	$tagFilter
array	$conds

Definition at line 390 of file HistoryAction.php.

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

Member Function Documentation

HistoryPager::curLink	(	$rev,
		$latest
	)

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

Parameters

Revision	$rev
bool	$latest	This is the latest revision of the page?

Returns: string

Definition at line 817 of file HistoryAction.php.

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

Referenced by historyLine().

HistoryPager::diffButtons	(	$rev,
		$firstInList
	)

Create radio buttons for page history.

Parameters

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

Returns: string HTML output for the radio buttons

Definition at line 891 of file HistoryAction.php.

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

Referenced by historyLine().

HistoryPager::doBatchLookups ( )

Definition at line 463 of file HistoryAction.php.

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

HistoryPager::formatRow ( $row )

Parameters

stdClass $row

Returns: string

Definition at line 443 of file HistoryAction.php.

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

HistoryPager::getArticle ( )

Definition at line 400 of file HistoryAction.php.

HistoryPager::getEndBody ( )

Definition at line 556 of file HistoryAction.php.

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

HistoryPager::getIndexField ( )

Definition at line 435 of file HistoryAction.php.

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns: bool

Definition at line 944 of file HistoryAction.php.

References $preventClickjacking.

HistoryPager::getQueryInfo ( )

Definition at line 412 of file HistoryAction.php.

References ContextSource\getWikiPage(), ChangeTags\modifyDisplayQuery(), Hooks\run(), Revision\selectFields(), Revision\selectUserFields(), and Revision\userJoinCond().

HistoryPager::getRevisionButton	(	$name,
		$msg
	)

private

Definition at line 540 of file HistoryAction.php.

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

Referenced by getStartBody().

HistoryPager::getSqlComment ( )

Definition at line 404 of file HistoryAction.php.

HistoryPager::getStartBody ( )

Creates begin of history list with a submit button.

Returns: string HTML output

Definition at line 494 of file HistoryAction.php.

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

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	$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	$latest	Whether this row corresponds to the page's latest revision.
bool	$firstInList	Whether this row corresponds to the first displayed on this history page.

Returns: string HTML output for the row

Definition at line 622 of file HistoryAction.php.

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

Referenced by formatRow(), and getEndBody().

HistoryPager::lastLink	(	$prevRev,
		$next
	)

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

Parameters

Revision	$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 843 of file HistoryAction.php.

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

Referenced by historyLine().

HistoryPager::preventClickjacking ( $enable = true )

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

Parameters

bool $enable

Definition at line 936 of file HistoryAction.php.

Referenced by getRevisionButton(), and historyLine().

HistoryPager::revLink ( $rev )

Create a link to view this revision of the page.

Parameters

Revision $rev

Returns: string

Definition at line 790 of file HistoryAction.php.

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

Referenced by historyLine().

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

Creates a submit button.

Parameters

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

Returns: string HTML output for the submit button

Definition at line 599 of file HistoryAction.php.

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

Referenced by getStartBody().

Member Data Documentation

HistoryPager::$buttons

Definition at line 370 of file HistoryAction.php.

Referenced by getEndBody(), and getStartBody().

HistoryPager::$conds

Definition at line 370 of file HistoryAction.php.

Referenced by __construct().

HistoryPager::$counter

Definition at line 370 of file HistoryAction.php.

HistoryPager::$historyPage

Definition at line 370 of file HistoryAction.php.

Referenced by __construct().

bool stdClass HistoryPager::$lastRow = false

Definition at line 368 of file HistoryAction.php.

HistoryPager::$oldIdChecked

protected

Definition at line 372 of file HistoryAction.php.

array HistoryPager::$parentLens

protected

Definition at line 378 of file HistoryAction.php.

HistoryPager::$preventClickjacking = false

protected

Definition at line 374 of file HistoryAction.php.

Referenced by getPreventClickjacking().

bool HistoryPager::$showTagEditUI

protected

Whether to show the tag editing UI.

Definition at line 381 of file HistoryAction.php.

Referenced by getStartBody().

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

includes/actions/HistoryAction.php

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation