MediaWiki  master
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

 __construct (Article $article, IContextSource $context, Parser $parser, PermissionManager $permissionManager, RevisionLookup $revisionLookup, RestrictionStore $restrictionStore)
 
 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 ()
 
 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)
 

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 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> element. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 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
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

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

Definition at line 42 of file RawAction.php.

Constructor & Destructor Documentation

◆ __construct()

RawAction::__construct ( Article  $article,
IContextSource  $context,
Parser  $parser,
PermissionManager  $permissionManager,
RevisionLookup  $revisionLookup,
RestrictionStore  $restrictionStore 
)
Parameters
Article$article
IContextSource$context
Parser$parser
PermissionManager$permissionManager
RevisionLookup$revisionLookup
RestrictionStore$restrictionStore

Definition at line 64 of file RawAction.php.

References Action\$context.

Member Function Documentation

◆ getContentType()

RawAction::getContentType ( )

Get the content type to use for the response.

Returns
string

Definition at line 314 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 79 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 272 of file RawAction.php.

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

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|false

Definition at line 220 of file RawAction.php.

References $content, $title, Action\getContext(), getOldId(), Action\getRequest(), Action\getTitle(), ParserOptions\newFromContext(), wfHttpError(), and wfTimestamp().

Referenced by onView().

◆ onView()

◆ requiresUnblock()

RawAction::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 87 of file RawAction.php.

◆ requiresWrite()

RawAction::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 83 of file RawAction.php.


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