Eventos

Nota

El módulo Eventos utiliza la clase estática EventsManager para gestionar los eventos.

Eventos principales del marco

Ubiquity emite eventos durante las diferentes fases del envío de una solicitud.
Estos eventos son relativamente pocos, para limitar su impacto en el rendimiento.

Parte	Nombre del evento	Parámetros	Ocurren cuando
ViewEvents	BEFORE_RENDER	viewname, parameters	Antes de renderizar una vista
ViewEvents	AFTER_RENDER	viewname, parameters	Después de renderizar una vista
DAOEvents	GET_ALL	objects, classname	Después de cargar varios objetos
DAOEvents	GET_ONE	object, classname	Después de cargar un objeto
DAOEvents	BEFORE_UPDATE	instance	Antes de actualizar un objeto
DAOEvents	AFTER_UPDATE	instance, result	Después de actualizar un objeto
DAOEvents	BEFORE_INSERT	instance	Antes de insertar un objeto
DAOEvents	AFTER_INSERT	instance, result	Después de insertar un objeto
RestEvents	BEFORE_INSERT	instance	Antes de insertar un objeto
RestEvents	BEFORE_UPDATE	instance	Antes de actualizar un objeto

Nota

No hay eventos BeforeAction y AfterAction, ya que los métodos initialize y finalize de la clase del controlador realizan esta operación.

Escuchar un evento

Example 1 :

Añadir una propiedad _updated en las instancias modificadas en la base de datos :

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;
             }
     });

Nota

Los parámetros que se pasan a la función callback varían según el evento que se esté escuchando.

Example 2 :

Modificación de la representación de la vista

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;
     });

Crear tus propios eventos

Example :

Crear un evento para contar y almacenar el número de visualizaciones por acción :

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 );
             }
     }

Registro de eventos

Registrando el evento TracePageEventListener en services.php :

app/config/services.php

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

     ...

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

Disparo de eventos

Un evento puede ser disparado desde cualquier lugar, pero tiene más sentido hacerlo aquí en el método initialize del controlador 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 );
                     }
             }
     }

El resultado en 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
     );

Eventos registro optimización

Es preferible almacenar en caché el registro de los listeners, para optimizar su tiempo de carga :

Crear un script de cliente, o una acción de controlador (no accesible en modo de producción) :

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();
}

Después de la ejecución, el archivo de caché se genera en app/cache/events/events.cache.php.

Una vez creada la caché, el archivo services.php sólo necesita tener la línea :

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