Elgg\Controllers\EntityEditAction Class Reference

Generic entity edit action controller. More...

Inheritance diagram for Elgg\Controllers\EntityEditAction:

Protected Member Functions
	executeBefore ()
	{Preparation before executing the action. Returns void } More...
	execute (array $skip_field_names=[])
	{} More...
	executeAfter ()
	{Action part after the main execution. Returns void } More...
	success (?string $forward_url=null)
	{} More...
	isNewEntity ()
	Is the entity being saved a new entity or being updated. More...
Protected Member Functions inherited from Elgg\Controllers\GenericAction
	sanitize ()
	Sanitizes input for the action. More...
	validate ()
	Validates the action. More...
	execute ()
	Main part of the action. 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
ElggEntity	$entity
bool	$is_new_entity = true
Protected Attributes inherited from Elgg\Controllers\GenericAction
Elgg Request	$request

Additional Inherited Members
Public Member Functions inherited from Elgg\Controllers\GenericAction
	__invoke (\Elgg\Request $request)
	Invoke the action steps. More...

Detailed Description

Generic entity edit action controller.

Since

6.2

Definition at line 15 of file EntityEditAction.php.

Member Function Documentation

execute()

Elgg\Controllers\EntityEditAction::execute ( array  $skip_field_names = [] )

protected

{}

Parameters

array

$skip_field_names

field names to skip when saving field metadata

Exceptions

ValidationException

Definition at line 76 of file EntityEditAction.php.

executeAfter()

Elgg\Controllers\EntityEditAction::executeAfter ( )

protected

{Action part after the main execution.

Returns

void

}

Exceptions

InternalServerErrorException

Reimplemented from Elgg\Controllers\GenericAction.

Definition at line 123 of file EntityEditAction.php.

executeBefore()

Elgg\Controllers\EntityEditAction::executeBefore ( )

protected

{Preparation before executing the action.

Returns

void

}

Exceptions

InternalServerErrorException
EntityPermissionsException

Reimplemented from Elgg\Controllers\GenericAction.

Definition at line 27 of file EntityEditAction.php.

isNewEntity()

Elgg\Controllers\EntityEditAction::isNewEntity ( )

protected

Is the entity being saved a new entity or being updated.

Returns

bool

Definition at line 173 of file EntityEditAction.php.

success()

Elgg\Controllers\EntityEditAction::success ( ?string  $forward_url = null )

protected

{}

Parameters

string | null

$forward_url

url to forward to

Definition at line 142 of file EntityEditAction.php.

Member Data Documentation

$entity

ElggEntity Elgg\Controllers\EntityEditAction::$entity

protected

Definition at line 17 of file EntityEditAction.php.

$is_new_entity

bool Elgg\Controllers\EntityEditAction::$is_new_entity = true

protected

Definition at line 19 of file EntityEditAction.php.

---

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

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