MediaWiki  REL1_31
RawAction Class Reference

A simple method to retrieve the plain source of an article, using "action=raw" in the GET request string. More...

Inheritance diagram for RawAction:
Collaboration diagram for RawAction:

Public Member Functions

 getContentType ()
 Get the content type to use for the response. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 getOldId ()
 Get the ID of the revision that should used to get the text. More...
 
 getRawText ()
 Get the text that should be returned, or false if the page or revision was not found. More...
 
 onView ()
 Show something on GET request. 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 ()
 The main action entry point. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 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...
 
 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...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists ( $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory ( $action, Page $page, 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 Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
- Protected Attributes inherited from Action
 $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
 $fields
 The fields used to create the HTMLForm. More...
 
 $page
 Page on which we're performing the action. More...
 

Detailed Description

A simple method to retrieve the plain source of an article, using "action=raw" in the GET request string.

Definition at line 37 of file RawAction.php.

Member Function Documentation

◆ getContentType()

RawAction::getContentType ( )

Get the content type to use for the response.

Returns
string

Definition at line 278 of file RawAction.php.

References Action\getRequest().

Referenced by onView().

◆ getName()

RawAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Definition at line 38 of file RawAction.php.

Referenced by onView().

◆ getOldId()

RawAction::getOldId ( )

Get the ID of the revision that should used to get the text.

Returns
int

Definition at line 245 of file RawAction.php.

References Action\getRequest(), Action\getTitle(), and page.

Referenced by getRawText().

◆ getRawText()

RawAction::getRawText ( )

Get the text that should be returned, or false if the page or revision was not found.

Returns
string|bool

Definition at line 177 of file RawAction.php.

References $request, $rev, $section, $title, $wgParser, Action\getContext(), getOldId(), Action\getRequest(), Action\getTitle(), global, ParserOptions\newFromContext(), Revision\newFromTitle(), NS_MEDIAWIKI, MessageCache\singleton(), wfHttpError(), and wfTimestamp().

Referenced by onView().

◆ onView()

RawAction::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 FormlessAction.

Definition at line 50 of file RawAction.php.

References $request, $response, $title, getContentType(), MediaWiki\Session\SessionManager\getGlobalSession(), getName(), Action\getOutput(), getRawText(), Action\getRequest(), Action\getTitle(), Action\getUser(), User\isEveryoneAllowed(), User\newFromName(), NS_MEDIAWIKI, page, Hooks\run(), wfDebug(), and wfMessage().

◆ requiresUnblock()

RawAction::requiresUnblock ( )

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

Since
1.17
Returns
bool

Reimplemented from Action.

Definition at line 46 of file RawAction.php.

◆ requiresWrite()

RawAction::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Since
1.17
Returns
bool

Reimplemented from Action.

Definition at line 42 of file RawAction.php.


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