MediaWiki  master
HistoryAction Class Reference

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

Inheritance diagram for HistoryAction:
Collaboration diagram for HistoryAction:

Public Member Functions

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

Public Attributes

array $message
 Array of message keys and strings. More...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists (string $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory (string $action, Article $article, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 
- Protected Attributes inherited from Action
IContextSource null $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 

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

References Action\getContext(), Action\getHookRunner(), Action\getLanguage(), Action\getTitle(), SpecialPage\getTitleFor(), Action\msg(), and Html\rawElement().

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

◆ getPageTitle()

HistoryAction::getPageTitle ( )
protected

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

Stability: stable
to override
Returns
string

Reimplemented from Action.

Definition at line 62 of file HistoryAction.php.

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

◆ onView()

HistoryAction::onView ( )

Print the history page for an article.

Returns
string|null

Reimplemented from FormlessAction.

Definition at line 146 of file HistoryAction.php.

References Action\getOutput(), and Action\getRequest().

◆ requiresUnblock()

HistoryAction::requiresUnblock ( )

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

Since
1.17
Stability: stable
to override
Returns
bool

Reimplemented from Action.

Definition at line 58 of file HistoryAction.php.

◆ requiresWrite()

HistoryAction::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Since
1.17
Stability: stable
to override
Returns
bool

Reimplemented from Action.

Definition at line 54 of file HistoryAction.php.

Member Data Documentation

◆ $message

array HistoryAction::$message

Array of message keys and strings.

Definition at line 48 of file HistoryAction.php.


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