CustomAction
class
CustomAction
Properties summary
| Type | Property | Description | |
|---|---|---|---|
| protected string | $identifier | ||
| protected string | $display | ||
| protected mixed | $callable | ||
| protected array | $params | ||
| protected array | $permissions | ||
| protected bool | $active | ||
| protected bool | $allowSamePage | ||
| protected bool | $preferIsolation |
Methods summary
| Return Type | Method Name | Description | |
|---|---|---|---|
| static CustomAction | factory(string $identifier, string $display, $callable, array $params = [], array $permissions = [], bool $active = true, bool $allowSamePage = false, bool $preferIsolation = false) | Initialise the CustomAction object providing the data that will be used on output. | |
| string | getIdentifier() | Get the identifier for the CustomAction object. | |
| CustomAction | setIdentifier(string $identifier) | Set the identifier for the CustomAction object. | |
| string | getDisplay() | Get the display for the CustomAction object. | |
| CustomAction | setDisplay(string $display) | Set the display for the CustomAction object. | |
| array | invokeCallable() | Invoke the callable function for the CustomAction object. | |
| CustomAction | setCallable(string|callable $callable) | Set the callable function for the CustomAction object. | |
| CustomAction | setParams(array $params) | Set the params for the CustomAction object. | |
| array | getPermissions() | Get the permissions for the CustomAction object. | |
| CustomAction | setPermissions(array $permissions) | Set the permissions for the CustomAction object. | |
| CustomAction | setActive(bool $active) | - | |
| bool | isActive() | - | |
| CustomAction | setAllowSamePage(bool $allowSamePage) | - | |
| bool | isAllowSamePage() | - | |
| CustomAction | setPreferIsolation(bool $preferIsolation) | - | |
| bool | isPreferIsolation() | - |
Details
static CustomAction
factory (string $identifier, string $display, $callable, array $params = [], array $permissions = [], bool $active = true, bool $allowSamePage = false, bool $preferIsolation = false)
Initialise the CustomAction object providing the data that will be used on output.
string
getIdentifier ()
Get the identifier for the CustomAction object.
protected CustomAction
setIdentifier (string $identifier)
Set the identifier for the CustomAction object.
string
getDisplay ()
Get the display for the CustomAction object.
protected CustomAction
setDisplay (string $display)
Set the display for the CustomAction object.
array
invokeCallable ()
Invoke the callable function for the CustomAction object.
protected CustomAction
setCallable (string|callable $callable)
Set the callable function for the CustomAction object.
protected CustomAction
setParams (array $params)
Set the params for the CustomAction object.
array
getPermissions ()
Get the permissions for the CustomAction object.
protected CustomAction
setPermissions (array $permissions)
Set the permissions for the CustomAction object.