Elgg\Controllers\GenericAction Class Reference

Generic action controller. More...

Inheritance diagram for Elgg\Controllers\GenericAction:

Public Member Functions
	__invoke (\Elgg\Request $request)
	Invoke the action steps. More...

Protected Member Functions
	sanitize ()
	Sanitizes input for the action. More...
	validate ()
	Validates the action. More...
	executeBefore ()
	Preparation before executing the action. More...
	execute ()
	Main part of the action. More...
	executeAfter ()
	Action part after the main execution. More...
	success ()
	Will be used when an action is successfully finished. More...
	error (string $message)
	Will be used when something wrong happened during the handling of the action. More...

Protected Attributes
Elgg Request	$request

Detailed Description

Generic action controller.

Since

6.2

Definition at line 13 of file GenericAction.php.

Member Function Documentation

Elgg\Controllers\GenericAction::__invoke ( \Elgg\Request  $request )

final

Invoke the action steps.

Parameters

\Elgg\Request

$request

the request for the action

Returns

Definition at line 24 of file GenericAction.php.

Elgg\Controllers\GenericAction::error ( string  $message )

protected

Will be used when something wrong happened during the handling of the action.

Parameters

string

$message

Message to show to the user

Returns

ErrorResponse

Definition at line 96 of file GenericAction.php.

Elgg\Controllers\GenericAction::execute ( )

protected

Main part of the action.

Returns

void

Definition at line 69 of file GenericAction.php.

Elgg\Controllers\GenericAction::executeAfter ( )

protected

Action part after the main execution.

Returns

void

Definition at line 77 of file GenericAction.php.

Elgg\Controllers\GenericAction::executeBefore ( )

protected

Preparation before executing the action.

Returns

void

Definition at line 61 of file GenericAction.php.

Elgg\Controllers\GenericAction::sanitize ( )

protected

Sanitizes input for the action.

Returns

void

Definition at line 45 of file GenericAction.php.

Elgg\Controllers\GenericAction::success ( )

protected

Will be used when an action is successfully finished.

Returns

OkResponse

Definition at line 85 of file GenericAction.php.

Elgg\Controllers\GenericAction::validate ( )

protected

Validates the action.

Returns

void

Definition at line 53 of file GenericAction.php.

Member Data Documentation

Elgg Request Elgg\Controllers\GenericAction::$request

protected

Definition at line 15 of file GenericAction.php.

---

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

• engine/classes/Elgg/Controllers/GenericAction.php