HistoryAction Class Reference

This class handles printing the history page for an article. More...

Inherits FormlessAction.

Collaboration diagram for HistoryAction:

Public Member Functions
	getName ()
	Return the name of the action this object responds to.
	onView ()
	Print the history page for an article.
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	requiresWrite ()
	Indicates whether this action page write access to the wiki.
Public Member Functions inherited from FormlessAction
	show ()
Public Member Functions inherited from Action
	__construct (Article $article, IContextSource $context)
	Only public since 1.21.
	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.
	doesWrites ()
	Indicates whether POST requests handled by this action require write access to the wiki.
	getArticle ()
	Get a Article object.
	getAuthority ()
	Shortcut to get the Authority executing this instance.
	getContext ()
	Get the IContextSource in use here.
	getLanguage ()
	Shortcut to get the user Language being used for this instance.
	getOutput ()
	Get the OutputPage being used for this instance.
	getRequest ()
	Get the WebRequest being used for this instance.
	getRestriction ()
	Get the permission required to perform this action.
	getSkin ()
	Shortcut to get the Skin being used for this instance.
	getTitle ()
	Shortcut to get the Title object from the page.
	getUser ()
	Shortcut to get the User being used for this instance.
	getWikiPage ()
	Get a WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	needsReadRights ()
	Indicates whether this action requires read rights.
	setHookContainer (HookContainer $hookContainer)

Public Attributes
array	$message
	Array of message keys and strings.

Protected Member Functions
	getDescription ()
	Returns the description that goes below the <h1> element.
	getPageTitle ()
	Returns the name that goes in the <h1> page title.
Protected Member Functions inherited from Action
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.
	getHookContainer ()
	getHookRunner ()
	setHeaders ()
	Set output headers for noindexing etc.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Additional Inherited Members
Static Public Member Functions inherited from Action
static	factory (string $action, Article $article, ?IContextSource $context=null)
	Get an appropriate Action subclass for the given action.
static	getActionName (IContextSource $context)
	Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.
Protected Attributes inherited from Action
IContextSource null	$context
	IContextSource if specified; otherwise we'll use the Context from the Page.
array	$fields
	The fields used to create the HTMLForm.

Detailed Description

This class handles printing the history page for an article.

In order to be efficient, it uses timestamps rather than offsets for paging, to avoid costly LIMIT,offset queries.

Construct it by passing in an Article, and call $h->history() to print the history.

Definition at line 49 of file HistoryAction.php.

Member Function Documentation

getDescription()

HistoryAction::getDescription ( )

protected

Returns the description that goes below the <h1> element.

Since

1.17

Stability: stable

to override

Returns

string HTML

Reimplemented from Action.

Definition at line 72 of file HistoryAction.php.

References Action\getContext(), Action\getHookRunner(), Action\getLanguage(), getTitle(), and Action\msg().

getName()

HistoryAction::getName

(

)

Return the name of the action this object responds to.

Since

1.17

Returns

string Lowercase name

Reimplemented from Action.

Definition at line 56 of file HistoryAction.php.

getPageTitle()

HistoryAction::getPageTitle ( )

protected

Returns the name that goes in the <h1> page title.

Since 1.41, returning a string from this method has been deprecated.

Stability: stable

to override

Returns

string|Message

Reimplemented from Action.

Definition at line 68 of file HistoryAction.php.

References getTitle(), and Action\msg().

onView()

HistoryAction::onView

(

)

Print the history page for an article.

Returns

string|null

Reimplemented from FormlessAction.

Definition at line 155 of file HistoryAction.php.

References Action\$fields, Action\addHelpLink(), Action\getArticle(), Action\getAuthority(), MediaWiki\Request\WebRequest\getBool(), MediaWiki\Request\WebRequest\getCheck(), Action\getContext(), Action\getHookRunner(), Action\getOutput(), MediaWiki\Request\WebRequest\getRawVal(), Action\getRequest(), getTitle(), MediaWiki\Watchlist\WatchlistManager\getTitleNotificationTimestamp(), Action\getUser(), MediaWiki\Request\WebRequest\getVal(), Action\getWikiPage(), Action\msg(), and wfScript().

requiresUnblock()

HistoryAction::requiresUnblock

(

)

Whether this action can still be executed by a blocked user.

Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since

1.17

Stability: stable

to override

Returns

bool

Reimplemented from Action.

Definition at line 64 of file HistoryAction.php.

requiresWrite()

HistoryAction::requiresWrite

(

)

Indicates whether this action page write access to the wiki.

Subclasses must override this method to return true if the operation they will perform is not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that subclasses handling POST requests might still implement "safe" operations, particularly in the case where large input parameters are required.

Since

1.17

Stability: stable

to override

Returns

bool

Reimplemented from Action.

Definition at line 60 of file HistoryAction.php.

Member Data Documentation

$message

array HistoryAction::$message

Array of message keys and strings.

Definition at line 54 of file HistoryAction.php.

---

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

• includes/actions/HistoryAction.php