BristolSU\Support\Action\Contracts\ActionManager Interface Reference

Inheritance diagram for BristolSU\Support\Action\Contracts\ActionManager:

Public Member Functions
	registerAction (string $class, string $name, string $description)
	all ()
	fromClass (string $class)

Detailed Description

Stores action classes and raw metadata

Definition at line 8 of file ActionManager.php.

Member Function Documentation

all()

BristolSU\Support\Action\Contracts\ActionManager::all

(

)

Return all registered actions.

Returns

array

Implemented in BristolSU\Support\Action\ActionManager.

fromClass()

BristolSU\Support\Action\Contracts\ActionManager::fromClass

(

string

$class

)

Return an action registered with the given class.

Parameters

string

$class

Class of the action

Exceptions

Implemented in BristolSU\Support\Action\ActionManager.

registerAction()

BristolSU\Support\Action\Contracts\ActionManager::registerAction	(	string	$class,
		string	$name,
		string	$description
	)

Register an action to be used.

An action is any class that implements the Action interface. Call the registerAction method in the service provider to register an action.

Parameters

string	$class	Class name of the action.
string	$name	A name for the action.
string	$description	A description of the action.

Returns

void

Implemented in BristolSU\Support\Action\ActionManager.

---

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

• src/Action/Contracts/ActionManager.php