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)
	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
bool stdClass	$lastRow = false
Protected Attributes
	$oldIdChecked
array	$parentLens
	$preventClickjacking = false
Private Member Functions
	getRevisionButton ($name, $msg)

Detailed Description

Definition at line 356 of file HistoryAction.php.

Constructor & Destructor Documentation

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

Parameters:

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

Definition at line 377 of file HistoryAction.php.

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

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

HistoryPager::formatRow ( $ row )

Parameters:

stdClass $row

Returns:: string

Reimplemented from IndexPager.

Definition at line 429 of file HistoryAction.php.

HistoryPager::getArticle ( )

Definition at line 386 of file HistoryAction.php.

HistoryPager::getEndBody ( )

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

Returns:: string

Reimplemented from IndexPager.

Definition at line 520 of file HistoryAction.php.

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

HistoryPager::getPreventClickjacking ( )

Get the "prevent clickjacking" flag.

Returns:: bool

Definition at line 896 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 398 of file HistoryAction.php.

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

Definition at line 504 of file HistoryAction.php.

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 390 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 471 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:

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

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

HistoryPager::preventClickjacking ( $ enable = true )

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

Parameters:

bool $enable

Definition at line 888 of file HistoryAction.php.

HistoryPager::revLink ( $ rev )

Create a link to view this revision of the page.

Parameters:

Revision $rev

Returns:: string

Definition at line 742 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 558 of file HistoryAction.php.

Member Data Documentation

HistoryPager::$buttons

Definition at line 361 of file HistoryAction.php.

HistoryPager::$conds

Definition at line 361 of file HistoryAction.php.

HistoryPager::$counter

Definition at line 361 of file HistoryAction.php.

HistoryPager::$historyPage

Definition at line 361 of file HistoryAction.php.

bool stdClass HistoryPager::$lastRow = false

Definition at line 359 of file HistoryAction.php.

HistoryPager::$oldIdChecked [protected]

Definition at line 363 of file HistoryAction.php.

array HistoryPager::$parentLens [protected]

Definition at line 368 of file HistoryAction.php.

HistoryPager::$preventClickjacking = false [protected]

Definition at line 365 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