Eventsystem¶
Im Eventsystem von Sally werden Benachrichtigungen über den globalen Dispatcher gesendet. Dieser bietet drei Verfahren, wie die Ergebnisse mehrerer Listener (Code, der auf Event reagiert) miteinander verknüpft werden:
- notify
- Die Listener werden nur benachrichtigt. Ihr Rückgabewert wird verworfen, jeder erhält das gleiche Subject.
- notifyUntil
- Wie notify, nur dass hierbei abgebrochen wird, wenn ein Listener true zurückgibt.
- filter
- Die Listener haben die Aufgabe, das Subject zu verändern. Der Rückgabewert eines Listeners wird an den nächsten als Subject weitergeleitet. Der Rückgabewert des Aufrufs ist das Ergebnis des letzten Listeners.
Dispatcher¶
Der Dispatcher kann wie folgt abgerufen werden:
<?
$dispatcher = sly_Core::dispatcher();
Events auslösen¶
Bei jedem Aufruf müssen zwei und können drei Argumente angegeben werden:
- event
- Der Name des Events. Per Konvention in Großschreibung (wie bei Konstanten, z.B. MY_ADDON_EVENT)
- subject
- Der Wert, der an die Listener übergeben werden soll. Siehe die Verknüpfungsstrategien für die Weitergabe des Subjects zwischen den Listenern.
- params (optional)
- Weitere Parameter als assoziatives Array.
Beispiel
<?
$dispatcher = sly_Core::dispatcher();
$nav = sly_Core::getNavigation();
// ein notify-Event mit einem String als Subject und ohne weitere Parameter
// auslösen
$dispatcher->notify('SLY_CONTROLLER_FOUND', 'theCurrentController');
// weitere Parameter mitgeben
$dispatcher->notify('SLY_CONTROLLER_FOUND', 'theCurrentController', array(
'myparam' => 'foo',
'object' => $this
));
// filter-Events geben den Rückgabewert des letzten Listeners zurück
// (in 99% der Fälle entspricht dies vom Typ dem, was als Subject reingegeben
// wurde)
$nav = $dispatcher->filter('SLY_LAYOUT_NAVI', $nav, array('myparam' => 'myvalue'));
Für Events registrieren¶
Ein Listener kann wie folgt registriert werden:
<?
function myFunc(array $params) {
$subject = $params['subject'];
}
$dispatcher = sly_Core::dispatcher();
$dispatcher->register('SLY_CONTROLLER_FOUND', 'myFunc');
Dabei ist zu beachten, dass der Listener korrekt auf die Verknüpfungsstragie reagiert: Wenn es sich um ein filter-Event handelt und ein Listener nichts zurückgibt, erhält der nächste Listener nur null als Subject.
Bemerkung
Listeners können beliebige PHP Callables sein (in PHP 5.3 natürlich auch Closures oder anonyme Funktionen).
Events¶
Dies ist eine Auflistung aller vom Core und der Backend-Anwendung gesendet Events.
Bemerkung
Leider sind die Events [noch] nicht konsistent benannt und haben daher nicht alle das Präfix SLY_. Wir arbeiten daran, die Namen nach und nach zu vereinheitlichen.
Zur Vereinfachung wird im Folgenden eine Pseudo-Syntax verwendet, um zu kennzeichnen, welche Ein- und Ausgaben die Events jeweils haben. Dabei wird so getan, als wären Events Methoden und ihre “Signaturen” aufgelistet.
- string MY_EVENT(string)
- Stellt ein Event dar, das einen string als Eingabe (“Subject”) erhält und einen String zurückgeben muss (ein Filter-Event). In den meisten Fällen müssen Listener den gleichen Typ zurückgeben, den sie auch im Subject reingegeben bekommen (damit der nachfolgende Listener happy ist).
- void ANOTHER_EVENT(int)
- Ein Event, das ein int als Eingabe erhält und nichts zurückgeben muss (ein Notify-Event). Rückgabewerte sind möglich, werden aber vom System nicht ausgewertet und sind daher nutzlos.
- string FILTER_UNTIL_EVENT(int) BREAKS
- Ein Event, das ebenfalls ein int als Eingabe erhält. Der erste Listener, der etwas anderes als null zurückgibt, “gewinnt” (ein Notify-Until-Event). Wird beispielsweise bei URL_REWRITE verwendet, bei dem die erste von einem Listener erzeugte URL gewinnt und alle weiteren Listener nicht ausgeführt werden.
Bemerkung
Neben dem Subject (das oben als Parameter dargestellt wird) werden einem Listener in vielen Fällen noch weitere Daten übergeben. Da diese keiner allgemeinen Struktur oder Reihenfolge folgen, werden sie in der Signatur nicht erwähnt.
Core¶
Die folgenden Events werden von der Kern-API ausgelöst und können (teilweise) sowohl im Backend (in jedem Backend, nicht zwangsweise dem Sally-Standardbackend) als auch im Frontend auftreten.
|
|
|
Backend¶
Diese Liste umfasst alle Events, die vom Sally-Backend ausgelöst werden. Sie umfasst nicht diejenigen Events, die von Models oder dem Core ausgelöst werden, selbst wenn deren API vom Backend aufgerufen wird.
|
|
Frontend¶
Diese Liste umfasst alle Events, die vom Sally-Frontend ausgelöst werden.
|
