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

List of all members.

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
 $preventClickjacking = false

Private Member Functions

 getRevisionButton ($name, $msg)

Detailed Description

Definition at line 315 of file HistoryAction.php.


Constructor & Destructor Documentation

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

Definition at line 320 of file HistoryAction.php.

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

Here is the call graph for this function:


Member Function Documentation

HistoryPager::curLink ( rev,
latest 
)

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

Parameters:
$revRevision
$latestBoolean: this is the latest revision of the page?
Returns:
String

Definition at line 671 of file HistoryAction.php.

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

Referenced by historyLine().

Here is the call graph for this function:

Here is the caller graph for this function:

HistoryPager::diffButtons ( rev,
firstInList 
)

Create radio buttons for page history.

Parameters:
$revRevision object
$firstInListBoolean: is this version the first one?
Returns:
String: HTML output for the radio buttons

Definition at line 738 of file HistoryAction.php.

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

Referenced by historyLine().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Abstract formatting function.

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

Parameters:
$rowObject: database row
Returns:
String

Reimplemented from IndexPager.

Definition at line 369 of file HistoryAction.php.

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

Here is the call graph for this function:

Definition at line 329 of file HistoryAction.php.

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

Returns:
String

Reimplemented from IndexPager.

Definition at line 449 of file HistoryAction.php.

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

Here is the call graph for this function:

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

Get the "prevent clickjacking" flag.

Definition at line 788 of file HistoryAction.php.

References preventClickjacking().

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

Definition at line 434 of file HistoryAction.php.

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

Referenced by getStartBody().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns:
String

Reimplemented from IndexPager.

Definition at line 333 of file HistoryAction.php.

Creates begin of history list with a submit button.

Returns:
string HTML output

Reimplemented from IndexPager.

Definition at line 405 of file HistoryAction.php.

References $wgScript, ContextSource\getOutput(), getRevisionButton(), ContextSource\getTitle(), ContextSource\getUser(), Html\hidden(), ContextSource\msg(), Html\openElement(), submitButton(), and Linker\tooltipAndAccesskeyAttribs().

Here is the call graph for this function:

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:
$rowObject: the database row corresponding to the previous line.
$nextMixed: the database row corresponding to the next line. (chronologically previous)
$notificationtimestamp
$latestBoolean: whether this row corresponds to the page's latest revision.
$firstInListBoolean: whether this row corresponds to the first displayed on this history page.
Returns:
String: HTML output for the row

Definition at line 507 of file HistoryAction.php.

References $user, Linker\buildRollbackLink(), Xml\check(), curLink(), Revision\DELETED_RESTRICTED, Revision\DELETED_TEXT, diffButtons(), false, ChangesList\flag(), ChangeTags\formatSummaryRow(), ContextSource\getLanguage(), ContextSource\getTitle(), ContextSource\getUser(), lastLink(), Linker\linkKnown(), ContextSource\msg(), preventClickjacking(), Html\rawElement(), Linker\revComment(), Linker\revDeleteLink(), Linker\revDeleteLinkDisabled(), revLink(), Linker\revUserTools(), ChangesList\showCharacterDifference(), Xml\tags(), and wfRunHooks().

Referenced by formatRow(), and getEndBody().

Here is the call graph for this function:

Here is the caller graph for this function:

HistoryPager::lastLink ( prevRev,
next 
)

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

Parameters:
$prevRevRevision: the previous revision
$nextMixed: the newer revision
Returns:
String

Definition at line 695 of file HistoryAction.php.

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

Referenced by historyLine().

Here is the call graph for this function:

Here is the caller graph for this function:

HistoryPager::preventClickjacking ( enable = true)

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

Definition at line 781 of file HistoryAction.php.

Referenced by getPreventClickjacking(), getRevisionButton(), and historyLine().

Here is the caller graph for this function:

Create a link to view this revision of the page.

Parameters:
$revRevision
Returns:
String

Definition at line 645 of file HistoryAction.php.

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

Referenced by historyLine().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Creates a submit button.

Parameters:
$messageString: text of the submit button, will be escaped
$attributesArray: attributes
Returns:
String: HTML output for the submit button

Definition at line 486 of file HistoryAction.php.

References IndexPager\getNumRows().

Referenced by getStartBody().

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

HistoryPager::$buttons

Definition at line 316 of file HistoryAction.php.

HistoryPager::$conds

Definition at line 316 of file HistoryAction.php.

Referenced by __construct().

HistoryPager::$counter

Definition at line 316 of file HistoryAction.php.

HistoryPager::$historyPage

Definition at line 316 of file HistoryAction.php.

Referenced by __construct().

HistoryPager::$lastRow = false

Definition at line 316 of file HistoryAction.php.

HistoryPager::$oldIdChecked [protected]

Definition at line 317 of file HistoryAction.php.

HistoryPager::$preventClickjacking = false [protected]

Definition at line 318 of file HistoryAction.php.


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