Inheritance diagram for HistoryPager:

Collaboration diagram for HistoryPager:

Public Member Functions
	__construct ($historyPage, $year= '', $month= '', $tagFilter= '', $conds=array())
	curLink ($rev, $latest)
	Create a diff-to-current link for this revision for this page.
	diffButtons ($rev, $firstInList)
	Create radio buttons for page history.
	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.
	formatRow ($row)
	Abstract formatting function.
	getArticle ()
	getEndBody ()
	Hook into getBody() for the end of the list.
	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.
	getPreventClickjacking ()
	Get the "prevent clickjacking" flag.
	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.
	getSqlComment ()
	Get some text to go in brackets in the "function name" part of the SQL comment.
	getStartBody ()
	Creates begin of history list with a submit button.
	historyLine ($row, $next, $notificationtimestamp=false, $latest=false, $firstInList=false)
	Returns a row from the history printout.
	lastLink ($prevRev, $next)
	Create a diff-to-previous link for this revision for this page.
	preventClickjacking ($enable=true)
	This is called if a write operation is possible from the generated HTML.
	revLink ($rev)
	Create a link to view this revision of the page.
	submitButton ($message, $attributes=array())
	Creates a submit button.
Public Attributes
	$buttons
	$conds
	$counter
	$historyPage
	$lastRow = false
Protected Attributes
	$oldIdChecked
array	$parentLens
	$preventClickjacking = false
Private Member Functions
	getRevisionButton ($name, $msg)

Detailed Description

Definition at line 337 of file HistoryAction.php.

Constructor & Destructor Documentation

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

Definition at line 345 of file HistoryAction.php.

References $conds, $historyPage, and ReverseChronologicalPager\getDateCond().

Member Function Documentation

HistoryPager::curLink	(	$	rev,
		$	latest
	)

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

Parameters:

$rev	Revision
$latest	Boolean: this is the latest revision of the page?

Returns:: String

Definition at line 717 of file HistoryAction.php.

HistoryPager::diffButtons	(	$	rev,
		$	firstInList
	)

Create radio buttons for page history.

Parameters:

$rev	Revision object
$firstInList	Boolean: is this version the first one?

Returns:: String: HTML output for the radio buttons

Definition at line 784 of file HistoryAction.php.

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 406 of file HistoryAction.php.

References $batch, array(), as, Revision\getParentLengths(), and of.

HistoryPager::formatRow ( $ row )

Abstract formatting function.

This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()

Parameters:

$row	Object: database row

Returns:: String

Reimplemented from IndexPager.

Definition at line 392 of file HistoryAction.php.

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

HistoryPager::getArticle ( )

Definition at line 354 of file HistoryAction.php.

HistoryPager::getEndBody ( )

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

Returns:: String

Reimplemented from IndexPager.

Definition at line 477 of file HistoryAction.php.

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

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 388 of file HistoryAction.php.

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns:: bool

Definition at line 835 of file HistoryAction.php.

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 366 of file HistoryAction.php.

References array(), ContextSource\getWikiPage(), ChangeTags\modifyDisplayQuery(), Revision\selectFields(), Revision\selectUserFields(), Revision\userJoinCond(), and wfRunHooks().

HistoryPager::getRevisionButton	(	$	name,
		$	msg
	)		`[private]`

Definition at line 462 of file HistoryAction.php.

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

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 358 of file HistoryAction.php.

HistoryPager::getStartBody ( )

Creates begin of history list with a submit button.

Returns:: string HTML output

Reimplemented from IndexPager.

Definition at line 433 of file HistoryAction.php.

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:

$row	Object: the database row corresponding to the previous line.
$next	Mixed: the database row corresponding to the next line. (chronologically previous)
$notificationtimestamp
$latest	Boolean: whether this row corresponds to the page's latest revision.
$firstInList	Boolean: whether this row corresponds to the first displayed on this history page.

Returns:: String: HTML output for the row

Definition at line 535 of file HistoryAction.php.

Referenced by formatRow(), and getEndBody().

HistoryPager::lastLink	(	$	prevRev,
		$	next
	)

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

Parameters:

$prevRev	Revision: the previous revision
$next	Mixed: the newer revision

Returns:: String

Definition at line 741 of file HistoryAction.php.

HistoryPager::preventClickjacking ( $ enable = true )

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

Definition at line 827 of file HistoryAction.php.

Referenced by getRevisionButton().

HistoryPager::revLink ( $ rev )

Create a link to view this revision of the page.

Parameters:

$rev Revision

Returns:: String

Definition at line 691 of file HistoryAction.php.

HistoryPager::submitButton	(	$	message,
		$	attributes = `array()`
	)

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 514 of file HistoryAction.php.

Member Data Documentation

HistoryPager::$buttons

Definition at line 338 of file HistoryAction.php.

HistoryPager::$conds

Definition at line 338 of file HistoryAction.php.

Referenced by __construct().

HistoryPager::$counter

Definition at line 338 of file HistoryAction.php.

HistoryPager::$historyPage

Definition at line 338 of file HistoryAction.php.

Referenced by __construct().

HistoryPager::$lastRow = false

Definition at line 338 of file HistoryAction.php.

HistoryPager::$oldIdChecked [protected]

Definition at line 339 of file HistoryAction.php.

array HistoryPager::$parentLens [protected]

Definition at line 343 of file HistoryAction.php.

HistoryPager::$preventClickjacking = false [protected]

Definition at line 340 of file HistoryAction.php.

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation