Gli Eventi

Introduzione

openDCN è una piattaforma costituita da moduli che necessitano di scambiarsi informazioni; questo scambio è controllato e gestito tramite il “sistema degli eventi”. Possiamo considerare “Evento” un qualsiasi cambiamento che si verifica nel Sistema.

Ogni modulo compie specifiche azioni solo al verificarsi di uno o più determinati eventi, in questo modo si forma un metodo di lavoro basato sulla modularità, nel senso che, come in una reazione a catena, non c’è conseguenza se non si scatena la causa.
Grazie a questo meccanismo, la piattaforma gode di una struttura modulare, facilmente modellabile, in quanto ogni singolo controller non è a conoscenza di ciò che accade a livello generale, ma risponde solo ad una specifica richiesta invocata da un altro controller e questo permette di implementare nuove funzioni senza dover modificare la struttura esistente.

Il pattern di riferimento per la gestione degli eventi si chiama “Implicit invocation”: ogni controller è registrato come “listener”, ovvero colui che aspetta il verificarsi di un'azione/evento alla quale risponde con un'altra azione.

La gestione in openDCN

OpenDCN gestisce gli eventi in questo modo:
per ogni controller esiste un file XML dove vengono inseriti gli eventi a cui risponde il controller stesso.
Il file si trova sempre all’interno di questo path: home/app/apis/nomeapi/nomeapi_event_handler.xml

Per far si che un controller risponda al verificarsi di un nuovo evento, basta inserire l’evento stesso nell’elenco all’interno di questo file, rispettando questa sintassi:

Esempio – agenda_event_handlers.xml:
Vogliamo aggiungere l’evento “permissionGetAction” all’elenco degli eventi a cui risponde l’agenda. Questo evento serve per capire i permessi relativi alle azioni che si possono fare all’interno dell’agenda.

  <handlers>
  ...
  <handler name="permissionsGetActions" event="Permissions.getActions"/>
  ...
  </handlers> 

Le funzioni che permettono di creare e gestire gli eventi sono definite principalmente nei file event_classes.php, event_parser.php e bootstrap.php che si trovano nella cartella home/app/apis/core.

Nel file event_classes.php sono definite le classi per creare eventi, nel file event_parser.php sono definite le funzioni che convalidano gli eventi presenti nel sistema ed il file bootstrap.php serve per far azionare l’effettivo parser degli eventi.

Le funzioni che descrivono le azioni dei controller per ogni evento cui rispondono sono definite, per ogni controller, nel file nomeapi_api_controller.php situato in apis/nomeapi/nomeapi_api_controller.php.

Esempio – agenda_api_controller.php:

  function permissionsGetActions() {		
     return array('admin' 	=>	$this->s('PERMISSION_ADMIN_DESCRIPTION'),
		'view' 		=>	$this->s('PERMISSION_VIEW_DESCRIPTION'),
		'create'	=>	$this->s('PERMISSION_CREATE_DESCRIPTION'),
		'upload'	=>	$this->s('PERMISSION_UPLOAD_DESCRIPTION'),
		'rate'		=>	$this->s('PERMISSION_RATE_DESCRIPTION'),
		'download'	=>	$this->s('PERMISSION_DOWNLOAD_DESCRIPTION'),
		'edit' 		=>	$this->s('PERMISSION_EDIT_DESCRIPTION'),
		'delete' 	=>	$this->s('PERMISSION_DELETE_DESCRIPTION'),
	);		
}

Infine, per notificare l’evento a tutti i controller, è stata creata la funzione notify, utilizzata dalla classe EventHandler nel file event_classes.php.
I controller riceveranno la richiesta e risponderanno attraverso la loro funzione corrispondente.

Funzione notify():

  static function notify($context,$event,$params = array(),$make_plain_array = false, $controller = null) {
	$eventObj = new EventHandler($context);
	return $eventObj->_notify($event,$params,$make_plain_array, $controller);
}

Esempio – permission_controller.php:
Il modulo dei permessi invoca la notify() che viene ricevuta da tutti i moduli registrati a quell'evento (getActions) - quindi anche dal modulo agenda - che risponde con la funzione di cui sopra (permissionsGetAction()).

  …
  $actions = $this->notify('Permissions.getActions');
  …

---

Elenco di tutti gli eventi sino ad ora registrati:

indietro - avanti