MediaWiki\Actions\RenderAction Class Reference
Handle action=render. More...
Inherits MediaWiki\Actions\FormlessAction.
Collaboration diagram for MediaWiki\Actions\RenderAction:
Public Member Functions | |
| getName () | |
Return the name of the action this object responds to.
| |
| onView () | |
Show something on GET request.
| |
| show () | |
| |
 Public Member Functions inherited from MediaWiki\Actions\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. | |
| requiresUnblock () | |
| Whether this action can still be executed by a blocked user. | |
| requiresWrite () | |
| Indicates whether this action page write access to the wiki. | |
| setHookContainer (HookContainer $hookContainer) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\Actions\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 Member Functions inherited from MediaWiki\Actions\Action | |
| checkCanExecute (User $user) | |
| Checks if the given user (identified by an object) can perform this action. | |
| getDescription () | |
Returns the description that goes below the <h1> element. | |
| getHookContainer () | |
| getHookRunner () | |
| getPageTitle () | |
Returns the name that goes in the <h1> page title. | |
| setHeaders () | |
| Set output headers for noindexing etc. | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. | |
| Protected Attributes inherited from MediaWiki\Actions\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
Handle action=render.
This is a wrapper that will call Article::render().
Definition at line 17 of file RenderAction.php.
Member Function Documentation
◆ getName()
| MediaWiki\Actions\RenderAction::getName | ( | ) |
Return the name of the action this object responds to.
- Since
- 1.17
- Returns
- string Lowercase name
Reimplemented from MediaWiki\Actions\Action.
Definition at line 20 of file RenderAction.php.
◆ onView()
| MediaWiki\Actions\RenderAction::onView | ( | ) |
Show something on GET request.
- Returns
- string|null Will be added to the HTMLForm if present, or just added to the output if not. Return null to not add anything
Reimplemented from MediaWiki\Actions\FormlessAction.
Definition at line 25 of file RenderAction.php.
◆ show()
| MediaWiki\Actions\RenderAction::show | ( | ) |
- Stability: stable
- to override
Reimplemented from MediaWiki\Actions\FormlessAction.
Definition at line 30 of file RenderAction.php.
References MediaWiki\Actions\Action\getArticle().
The documentation for this class was generated from the following file:
- includes/Actions/RenderAction.php
