Events

Events are available in the frontend and the backend. Both implementations provide the same functionality and are implemented in a similar way.

Creating Events

Every event requires a unique trigger key as well as a \Closure which should be called once the event is triggered.

$eventManager->attach('eventId', function() { echo 'Hello World'; });

The eventId can also be a regex in order to let it trigger on multiple occasions (e.g. $eventManager->attach('/Test[a-z]+/', ...))

Repeating events

If a event should only be able to be triggered once another boolean parameter has to be added to the attach() function call.

$eventManager->attach('eventId', function() { echo 'Hello World'; }, true);

Now the event will be removed from the event manager once executed.

Resetting events

In case an event should be reset (all conditions must be met again before it can be triggered) after it got successfully triggered one more parameter can be added.

$eventManager->attach('eventId', function() { echo 'Hello World'; }, false, true);

This only works if also the event isn't removed after triggering

Triggering Events

An event can be triggered by calling the trigger() function.

$eventManager->trigger('eventId');

Triggering Similar Events

In some situations you might want to trigger multiple events. In this case you can provide a regex as eventId and/or conditionName (e.g. $eventManager->trigger('/[a-z]+/'))

Multi Condition Events

In some cases it is required that multiple conditions are met before an event is supposed to be triggered. This can be achieved by registering these conditions through the addGroup() function.

$eventManager->addGroup('eventId', 'conditionName');
$eventManager->addGroup('eventId', 'conditionName2');

Now the event will only be triggered once every registered condition was triggered.

$eventManager->trigger('eventId', 'conditionName'); // No output
$eventManager->trigger('eventId', 'conditionName2'); // Hello World
$eventManager->trigger('eventId'); // Hello World
$eventManager->trigger('eventId', 'conditionName'); // Hello World (if remove = false && reset = false)
$eventManager->trigger('eventId', 'conditionName'); // No output (if remove = false && reset = true)
$eventManager->trigger('eventId', 'conditionName'); // No output (if remove = true)

The order in which these conditions are triggered doesn't mapper. A multi condition event SHOULD be attached with the optional boolean parameter true. These events can only be executed once and will be removed afterwards. In case the optional boolean parameter was not set to true the event will remain in the event manager and will be triggered whenever trigger('eventId') is called.

Frontend vs. Backend

The only key difference between the frontend and backend implementation is that the frontend prevents running the same event in quick succession (less than 300 ms) in order to prevent undesired effects which can happen due to quick UI interaction.

3.0 KiB Raw Blame History