Evènements

Note

Le module Events utilise la classe statique EventsManager pour gérer les évènements.

Framework core events

Ubiquity émet des événements lors des différentes phases de soumission d’une requête.
Ces événements sont relativement peu nombreux, afin de limiter leur impact sur les performances.

Partie	Nom d’évènement	Paramètres	Se produit quand
ViewEvents	BEFORE_RENDER	viewname, parameters	Avant d’afficher une vue
ViewEvents	AFTER_RENDER	viewname, parameters	Après l’affichage d’une vue
DAOEvents	GET_ALL	objects, classname	Après le chargement d’un ensemble d’objets
DAOEvents	GET_ONE	object, classname	Après le chargement d’un objet
DAOEvents	BEFORE_UPDATE	instance	Avant la mise à jour d’un objet
DAOEvents	AFTER_UPDATE	instance, result	Après mise à jour d’un objet
DAOEvents	BEFORE_INSERT	instance	Avant l’insertion d’un objet
DAOEvents	AFTER_INSERT	instance, result	Après l’insertion d’un objet
RestEvents	BEFORE_INSERT	instance	Avant l’insertion d’un objet
RestEvents	BEFORE_UPDATE	instance	Avant la mise à jour d’un objet

Note

Il n’y a pas d’événement BeforeAction et AfterAction, puisque les méthodes initialize et finalize de la classe contrôleur effectuent ces opérations.

Ecouter un évènement

Exemple 1 :

Ajout d’une propriété _updated sur les instances modifiées dans la base de données :

app/config/services.php

use Ubiquity\events\EventsManager;
use Ubiquity\events\DAOEvents;

...

     EventsManager::addListener(DAOEvents::AFTER_UPDATE, function($instance,$result){
             if($result==1){
                     $instance->_updated=true;
             }
     });

Note

Les paramètres passés à la fonction de callback varient en fonction de l’évènement écouté.

Exemple 2 :

Modification de l’affichage de la vue

app/config/services.php

use Ubiquity\events\EventsManager;
use Ubiquity\events\ViewEvents;

...

     EventsManager::addListener(ViewEvents::AFTER_RENDER,function(&$render,$viewname,$datas){
             $render='<h1>'.$viewname.'</h1>'.$render;
     });

Créer ses propres évènements

Exemple :

Création d’un évènement pour compter et mémoriser le nombre d’affichages par action :

app/eventListener/TracePageEventListener.php

     namespace eventListener;

     use Ubiquity\events\EventListenerInterface;
     use Ubiquity\utils\base\UArray;

     class TracePageEventListener implements EventListenerInterface {
             const EVENT_NAME = 'tracePage';

             public function on(&...$params) {
                     $filename = \ROOT . \DS . 'config\stats.php';
                     $stats = [ ];
                     if (file_exists ( $filename )) {
                             $stats = include $filename;
                     }
                     $page = $params [0] . '::' . $params [1];
                     $value = $stats [$page] ?? 0;
                     $value ++;
                     $stats [$page] = $value;
                     UArray::save ( $stats, $filename );
             }
     }

Enregistrement d’évènements

Enregistrement de l’évènement TracePageEventListener dans services.php :

app/config/services.php

     use Ubiquity\events\EventsManager;
     use eventListener\TracePageEventListener;

     ...

     EventsManager::addListener(TracePageEventListener::EVENT_NAME, TracePageEventListener::class);

Déclencher des évènements

Un évènement peut être déclenché depuis n’importe quel contexte, mais il est plus logique de le faire depuis la méthode initialize du contrôleur de base.

app/controllers/ControllerBase.php

     namespace controllers;

     use Ubiquity\controllers\Controller;
     use Ubiquity\utils\http\URequest;
     use Ubiquity\events\EventsManager;
     use eventListener\TracePageEventListener;
     use Ubiquity\controllers\Startup;

     /**
      * ControllerBase.
      **/
     abstract class ControllerBase extends Controller{
             protected $headerView = "@activeTheme/main/vHeader.html";
             protected $footerView = "@activeTheme/main/vFooter.html";
             public function initialize() {
                     $controller=Startup::getController();
                     $action=Startup::getAction();
                     EventsManager::trigger(TracePageEventListener::EVENT_NAME, $controller,$action);
                     if (! URequest::isAjax ()) {
                             $this->loadView ( $this->headerView );
                     }
             }
             public function finalize() {
                     if (! URequest::isAjax ()) {
                             $this->loadView ( $this->footerView );
                     }
             }
     }

Le résultat dans app/config/stats.php :

app/config/stats.php

return array(
             "controllers\\IndexController::index"=>5,
             "controllers\\IndexController::ct"=>1,
             "controllers\\NewController::index"=>1,
             "controllers\\TestUCookieController::index"=>1
     );

Optimisation de l’enregistrement d’évènements

Il est préférable de mettre en cache l’enregistrement des écouteurs, afin d’optimiser leur temps de chargement :

Créer un script client, ou une action contrôleur (non accessible en mode production) :

use Ubiquity\events\EventsManager;

public function initEvents(){
        EventsManager::start();
        EventsManager::addListener(DAOEvents::AFTER_UPDATE, function($instance,$result){
                if($result==1){
                        $instance->_updated=true;
                }
        });
        EventsManager::addListener(TracePageEventListener::EVENT_NAME, TracePageEventListener::class);
        EventsManager::store();
}

Après exécution, le cache est généré dans le fichier app/cache/events/events.cache.php.

Une fois le cache généré, le fichier services.php doit juste inclure cette ligne :

\Ubiquity\events\EventsManager::start();