An action which just does something, without showing a form first. More...

Inheritance diagram for FormlessAction:

[legend]

Collaboration diagram for FormlessAction:

[legend]

Public Member Functions
	execute (array $data=null, $captureErrors=true)
	Execute the action silently, not giving any output. More...

	onSubmit ( $data)

	onSuccess ()

	onView ()
	Show something on GET request. More...

	show ()
	The main action entry point. More...

Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	Constructor. More...

	execute ()
	Execute the action in a silent fashion: do not display anything or release any errors. More...

	getContext ()
	Get the IContextSource in use here. More...

	getLang ()
	Shortcut to get the user Language being used for this instance. More...

	getLanguage ()
	Shortcut to get the user Language being used for this instance. More...

	getName ()
	Return the name of the action this object responds to. 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 ()
	Get a Message object with context set Parameters are the same as wfMessage() 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...

Protected Member Functions
	getFormFields ()
	We don't want an HTMLForm. 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...

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 Attributes inherited from Action
IContextSource	$context
	IContextSource if specified; otherwise we'll use the Context from the Page $context. More...

array	$fields
	The fields used to create the HTMLForm $fields. More...

WikiPage Article ImagePage CategoryPage Page	$page
	Page on which we're performing the action $page. More...

Detailed Description

An action which just does something, without showing a form first.

Definition at line 29 of file FormlessAction.php.

Member Function Documentation

◆ execute()

FormlessAction::execute	(	array	$data = `null`,
			$captureErrors = `true`
	)

Execute the action silently, not giving any output.

Since these actions don't have forms, they probably won't have any data, but some (eg rollback) may do

Parameters

array	$data	Values that would normally be in the GET request
bool	$captureErrors	Whether to catch exceptions and just return false

Exceptions

ErrorPageError|Exception

Returns: bool Whether execution was successful

Definition at line 78 of file FormlessAction.php.

References $e, Action\checkCanExecute(), Action\getContext(), Action\getUser(), and onView().

◆ getFormFields()

FormlessAction::getFormFields ( )

protected

We don't want an HTMLForm.

Returns: bool

Definition at line 42 of file FormlessAction.php.

◆ onSubmit()

FormlessAction::onSubmit ( $data )

Parameters

array $data

Returns: bool

Definition at line 50 of file FormlessAction.php.

◆ onSuccess()

FormlessAction::onSuccess ( )

Returns: bool

Definition at line 57 of file FormlessAction.php.

◆ onView()

FormlessAction::onView ( )

abstract

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 in HistoryAction, InfoAction, RawAction, RevisiondeleteAction, CreditsAction, EditAction, MarkpatrolledAction, DeleteAction, ProtectAction, RenderAction, ViewAction, and RollbackAction.

Referenced by execute(), and show().

◆ show()

FormlessAction::show ( )

The main action entry point.

Do all output for display and send it to the context output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use $this->getOutput(), etc.

Exceptions

ErrorPageError

Reimplemented from Action.

Reimplemented in SubmitAction, UnprotectAction, RevisiondeleteAction, EditAction, DeleteAction, ProtectAction, RenderAction, and ViewAction.

Definition at line 61 of file FormlessAction.php.

References Action\checkCanExecute(), Action\getOutput(), Action\getUser(), onView(), and Action\setHeaders().

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

includes/actions/FormlessAction.php

Public Member Functions

Protected Member Functions

Additional Inherited Members