RawAction Class Reference

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

Inherits FormlessAction.

Collaboration diagram for RawAction:

Public Member Functions
	__construct (Article $article, IContextSource $context, Parser $parser, PermissionManager $permissionManager, RevisionLookup $revisionLookup, RestrictionStore $restrictionStore, UserFactory $userFactory)
	getContentType ()
	Get the content type to be used for the response.
	getName ()
	Return the name of the action this object responds to. Since 1.17 Returns string Lowercase name
	getOldId ()
	Get the ID of the revision that should be used to get the text.
	getRawText ()
	Get the text that should be returned, or false if the page or revision was not found.
	onView ()
	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)

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 Member Functions inherited from 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 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

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

Definition at line 48 of file RawAction.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

Article	$article
IContextSource	$context
Parser	$parser
PermissionManager	$permissionManager
RevisionLookup	$revisionLookup
RestrictionStore	$restrictionStore
UserFactory	$userFactory

Definition at line 65 of file RawAction.php.

Member Function Documentation

getContentType()

RawAction::getContentType

(

)

Get the content type to be used for the response.

Returns

string

Definition at line 331 of file RawAction.php.

References $ctype, and 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 83 of file RawAction.php.

Referenced by onView().

getOldId()

RawAction::getOldId

(

)

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

Returns

int

Definition at line 289 of file RawAction.php.

References 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 225 of file RawAction.php.

References getContext(), getOldId(), getRequest(), getTitle(), wfHttpError(), and wfTimestamp().

Referenced by onView().

onView()

RawAction::onView

(

)

Returns

string|null

Reimplemented from FormlessAction.

Definition at line 99 of file RawAction.php.

References getAuthority(), getContentType(), Action\getHookRunner(), getName(), Action\getOutput(), getRawText(), getRequest(), getTitle(), getUser(), Action\getWikiPage(), NS_MEDIAWIKI, wfDebug(), and wfMessage().

requiresUnblock()

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

requiresWrite()

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

---

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

• includes/actions/RawAction.php