L'objet jEvent sert à la fois d'émetteur d'évènement, et en même temps de conteneur des réponses.

sa principale méthode, qui est statique, est notify :

   $ev = jEvent::notify('nom_evenement', $parametre_event);

Elle accepte en paramètre un nom d'évènement (qui n'est constitué que de caractères alphanumériques), et un tableau facultatif de paramètres (à utiliser selon l'évènement).

Vous recevez en retour l'objet jEvent instancié pour l'occasion, et contenant les réponses. Les réponses sont un ensemble de valeurs dont la structure et le nombre dépend de l'évènement et du nombre de modules ayant répondu.

Pour avoir ces réponses :

  $reponses = $ev->getResponse();

Pour qu'un module puisse répondre à un évènement, il faut créer un listener, et le déclarer dans le fichier events.xml du module.

Il faut d'abord lui donner un nom. Foo par exemple, ensuite il faut créer une classe fooListener (se termine toujours par “Listener”), héritant de jEventListener et stockée dans le fichier classes/foo.listener.php du module.

Cette classe contient une méthode pour chaque évènement auquel le listener répond. Ces noms de méthodes commencent par “on” suivit du nom d'évènement. Et ces méthodes prennent en paramètre l'objet jEvent correspondant à l'évènement. Exemple :

class authListener extends jEventListener{
 
   function onAuthCanLogin ($event) {
        $user = $event->getParam('user');
        $ok = true;
        if(isset($user->actif)){
            $ok = ($user->actif == '1');
        }
 
        $ok = $ok && ($user->password != '');
 
        $event->Add(array('canlogin'=>$ok));
   }
}

Ce listener répond à l'évènement “AuthCanLogin”. La méthode récupère le paramètre 'user' de l'évènement. Et ajoute une donnée dans la réponse ($event→add). Ce paramètre et cette donnée de réponse dépendent uniquement de l'évènement AuthCanLogin. Pour d'autres évènements, il peut y avoir plusieurs paramètres ou aucun, d'autres types de données de réponses ou aucune réponse.

il faut ensuite déclarer le listener. Cela se fait dans un fichier events.xml placé à la racine du module. Voici un exemple :

<events xmlns="http://jelix.org/ns/events/1.0">
   <listener name="auth">
       <event name="AuthCanLogin" />
       <event name="FetchXulOverlay" />
   </listener>
</events>

Vous mettez autant de balise listener que de listener stocké dans le répertoire classes du module. Et dans chacune d'elles vous indiquez tous les évènements que prend en charge le listener, grâce à des balises event.