1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Core
  7. \
  8. Helper
  9. \
  10. ActionHandlerHelper

ActionHandlerHelper

class ActionHandlerHelper implements ItemListInterface, CollectionActionHandlerInterface

Traits

ItemListTrait

Constants

TRIGGER_DEFAULT

Methods

ActionHandlerHelper
addAction(ActionHelper $actionHelper, string $trigger = self::TRIGGER_DEFAULT)

Bind possible action to trigger

int
count()

No description

from  ItemListTrait
static ItemListTrait
create(ItemInterface ...$items)

No description

from  ItemListTrait
ItemInterface|null
first()

Get first element

from  ItemListTrait
string|null
getActionHandlerEndpoint()

No description

Collection|null
getCollection()

Return collection if is set

array
getItems()

No description

from  ItemListTrait
ActionHelper[]
getIterator()

No description

array
getRegisteredActions(string $trigger)

Return actions that are registered in this handler for a specific trigger

array
jsonSerialize()

No description

from  ItemListTrait
ItemInterface|null
last()

Return the last element

from  ItemListTrait
bool
offsetExists($offset)

No description

from  ItemListTrait
ActionHelper
offsetGet(mixed $offset)

No description

void
offsetSet($offset, $value)

No description

from  ItemListTrait
void
offsetUnset($offset)

No description

from  ItemListTrait
int
push(ItemInterface $item)

No description

void
sendFeedbackAsFlashMessages()

Send Feedback Messages

ActionHandlerHelper
setActionHandlerEndpoint(string|null $actionHandlerEndpoint)

No description

CollectionActionHandlerInterface
setCollection(Collection $collection)

Set collection for CollectionActionHelper

void
setItems(array $items)

No description

from  ItemListTrait
array
toArray()

Transforms the option into an array.

from  ItemListTrait
bool|null
triggerAction(string $actionKey = null, string $trigger = self::TRIGGER_DEFAULT)

Trigger and Execute all actions or Execute specific action for specific trigger

int
unshift(ItemInterface $item)

No description

from  ItemListTrait

Details

at line 44
ActionHandlerHelper addAction(ActionHelper $actionHelper, string $trigger = self::TRIGGER_DEFAULT)

Bind possible action to trigger

Parameters

ActionHelper $actionHelper
string $trigger

Return Value

ActionHandlerHelper

in ItemListTrait at line 147
int count()

No description

Return Value

int

in ItemListTrait at line 37
static ItemListTrait create(ItemInterface ...$items)

No description

Parameters

ItemInterface ...$items

Return Value

ItemListTrait

in ItemListTrait at line 96
ItemInterface|null first()

Get first element

Return Value

ItemInterface|null

at line 212
string|null getActionHandlerEndpoint()

No description

Return Value

string|null

at line 178
Collection|null getCollection()

Return collection if is set

Return Value

Collection|null

in ItemListTrait at line 57
array getItems()

No description

Return Value

array

at line 17
ActionHelper[] getIterator()

No description

Return Value

ActionHelper[]

at line 189
array getRegisteredActions(string $trigger)

Return actions that are registered in this handler for a specific trigger

Parameters

string $trigger

Return Value

array

in ItemListTrait at line 154
array jsonSerialize()

No description

Return Value

array

in ItemListTrait at line 88
ItemInterface|null last()

Return the last element

Return Value

ItemInterface|null

in ItemListTrait at line 116
bool offsetExists($offset)

No description

Parameters

$offset

Return Value

bool

at line 17
ActionHelper offsetGet(mixed $offset)

No description

Parameters

mixed $offset

Return Value

ActionHelper

in ItemListTrait at line 133
void offsetSet($offset, $value)

No description

Parameters

$offset
$value

Return Value

void

in ItemListTrait at line 140
void offsetUnset($offset)

No description

Parameters

$offset

Return Value

void

at line 55
int push(ItemInterface $item)

No description

Parameters

ItemInterface $item

Return Value

int

Returns the new number of items in the list.

See also

addAction()

at line 120
void sendFeedbackAsFlashMessages()

Send Feedback Messages

Return Value

void

at line 204
ActionHandlerHelper setActionHandlerEndpoint(string|null $actionHandlerEndpoint)

No description

Parameters

string|null $actionHandlerEndpoint

Return Value

ActionHandlerHelper

at line 168
CollectionActionHandlerInterface setCollection(Collection $collection)

Set collection for CollectionActionHelper

Parameters

Collection $collection

Return Value

CollectionActionHandlerInterface

in ItemListTrait at line 66
void setItems(array $items)

No description

Parameters

array $items

Return Value

void

in ItemListTrait at line 74
array toArray()

Transforms the option into an array.

Return Value

array

at line 73
bool|null triggerAction(string $actionKey = null, string $trigger = self::TRIGGER_DEFAULT)

Trigger and Execute all actions or Execute specific action for specific trigger

Parameters

string $actionKey
string $trigger

Return Value

bool|null

Returns null if no action was executed, True for successful execution, False for error

in ItemListTrait at line 49
int unshift(ItemInterface $item)

No description

Parameters

ItemInterface $item

Return Value

int