API du gestionnaire d'événement : Différence entre versions

Version du 11 mai 2010 à 10:59

table des listener

• id
• event_class_name
• function_name
• require_file
• addon_name
• priority

event_class_name est le nom d'une classe héritée de bab_event

function_name est le nom d'une fonction déclarée dans le ficher spécifié dans la colonne require_file

le paramètre require_file est le chemin relatif au noyau d'ovidentia d'un fichier php

le paramètre priority (optionnel) permet de régler l'ordre d'appel des fonctions enregistrés pour un même événement

Ajouter un listener :

<source lang="php"> global $babInstallPath; include_once $babInstallPath.'utilit/eventincl.php'; bab_addEventListener('event_class_name', 'function_name', 'require_file', 'addon_name'); </source>

Enlever un listener :

<source lang="php"> bab_removeEventListener('event_class_name', 'function_name', 'require_file', 'addon_name'); </source>

La fonction inscrite dans la colonne function_name sera délarée dans le fichier 'require_file' comme ceci :

<source lang="php"> function ats_onBabPasswordModified(&$event) {

} </source>

Déclencher un événement

Lorsqu'un événement est déclenché, toutes les fonctions enregistrées dans la table des "listener" qui ont pour event_class_name le nom de l'objet ou le nom d'un des parents de l'objet sont appelés ; pour chaque enregistrement, on effectue les actions suivantes :

1. si 'addon_name' est un nom de module valide, le contexte du module est créé
2. le nom du fichier contenu dans 'require_file' est inclus avec la fonction require_once
3. la fonction 'function_name' est appelée avec un seul paramètre qui est l'instance de l'événement

<source lang="php">

class bab_userModified extends bab_event {

}

class bab_passwordModified extends bab_userModified {

}

$event_obj = new bab_passwordModified();

bab_fireEvent($event_obj);

</source>

L'ordre d'appel des fonctions enregistrées dans le listener est indéterminé (le premier enregistré est le premier appelé)

Gestion des priorités

Afin de gérer l'ordre dans lequel les fonction sont appelées, il est possible d'ajouter une priorité au moment de l'enregistrement dans l'événement

par exemple dans ce cas, la fonction 2 sera appelée avant la fonction 1.

<source lang="php">

bab_addEventListener('event_class_name', 'function_1', 'require_file', 'addon_name', 50); bab_addEventListener('event_class_name', 'function_2', 'require_file', 'addon_name', 100);

</source>

Par défaut, la priorité est à la valeur 0, les appels sont traités dans un ordre indéterminé (qui est probablement l'ordre de l'enregistrement.

Tous les événements disponibles

Ovidentia