BristolSU\Support\Action\Contracts\RegisteredAction Interface Reference

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

Public Member Functions
	setName (string $name)
	getName ()
	setDescription (string $description)
	getDescription ()
	setClassName (string $className)
	getClassName ()
	toArray ()
	toJson ($options=0)

Static Public Member Functions
static	fromArray (array $parameters)

Detailed Description

Class to set and access action metadata.

Definition at line 8 of file RegisteredAction.php.

Member Function Documentation

fromArray()

static BristolSU\Support\Action\Contracts\RegisteredAction::fromArray ( array  $parameters )

static

Create a RegisteredAction instance from a raw metadata array.

Creates a RegisteredAction instance from an array of the form [ 'name' => 'Action Name', 'description' => 'Action Description', 'class' => 'ClassName' ]

Parameters

array

$parameters

The raw metadata of the action

Returns

RegisteredAction

Implemented in BristolSU\Support\Action\RegisteredAction.

getClassName()

BristolSU\Support\Action\Contracts\RegisteredAction::getClassName

(

)

Get the class name of the action

Returns

string

Implemented in BristolSU\Support\Action\RegisteredAction.

getDescription()

BristolSU\Support\Action\Contracts\RegisteredAction::getDescription

(

)

Get the action description

Returns

string

Implemented in BristolSU\Support\Action\RegisteredAction.

getName()

BristolSU\Support\Action\Contracts\RegisteredAction::getName

(

)

Get the name of the action.

Returns

string

Implemented in BristolSU\Support\Action\RegisteredAction.

setClassName()

BristolSU\Support\Action\Contracts\RegisteredAction::setClassName

(

string

$className

)

Set the class name of the action.

Parameters

string

$className

Class of the action

Returns

void

Implemented in BristolSU\Support\Action\RegisteredAction.

setDescription()

BristolSU\Support\Action\Contracts\RegisteredAction::setDescription

(

string

$description

)

Set the description of the action.

Parameters

string

$description

Description of the action

Returns

void

Implemented in BristolSU\Support\Action\RegisteredAction.

setName()

BristolSU\Support\Action\Contracts\RegisteredAction::setName

(

string

$name

)

Set the name of the action.

Parameters

string

$name

Name of the action

Returns

void

Implemented in BristolSU\Support\Action\RegisteredAction.

toArray()

BristolSU\Support\Action\Contracts\RegisteredAction::toArray

(

)

Transform the action to an array

Returns

array

Implemented in BristolSU\Support\Action\RegisteredAction.

toJson()

BristolSU\Support\Action\Contracts\RegisteredAction::toJson

(

$options = 0

)

Transform the action to json

Parameters

int

$options

Returns

string

Implemented in BristolSU\Support\Action\RegisteredAction.

---

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

• src/Action/Contracts/RegisteredAction.php