Global event handler. More...

Collaboration diagram for ilAppEventHandler:

Public Member Functions
	__construct ()
	Constructor. More...

Protected Member Functions
	initListeners ()

Protected Attributes
	$db

	$listener

	$logger

Detailed Description

Global event handler.

The event handler delegates application events (not gui events) between components that trigger events and components that listen to events. A component is a module or a service.

The component that triggers an event calls the raise function of the event handler through the global instance ilAppEventHandler:

E.g. in ilObjUser->delete(): $ilAppEventHandler->raise("Services/User", "deleteUser", array("id" => ..., ...))

A listener has to subscribe to the events of another component. This currently is done here in the constructor, e.g. if the News service listens to the User service, add a $this->listener["Services/User"] = array("Services/News"); This information will go to xml files in the future.

A component has to implement a listener class that implements Services/EventHandling/interfaces/interface.ilAppEventListener.php

The location must be <component>/classes/class.il<comp_name>AppEventListener.php, e.g. ./Services/News/classes/class.ilNewsAppEventListener.php

The class name must be il<comp_name>AppEventListener.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id$

Definition at line 56 of file class.ilAppEventHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilAppEventHandler::__construct ( )

Constructor.

Definition at line 73 of file class.ilAppEventHandler.php.

References $DIC, ilLoggerFactory\getLogger(), and initListeners().

Referenced by initListeners().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->initListeners();
 
         $this->logger = \ilLoggerFactory::getLogger('evnt');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ initListeners()

ilAppEventHandler::initListeners ( )

protected

Definition at line 83 of file class.ilAppEventHandler.php.

References $db, $ilDB, $listener, $name, XapiProxy\$plugin, $res, __construct(), ilGlobalCache\COMP_EVENTS, ilPluginAdmin\getActivePlugins(), ilPluginAdmin\getActivePluginsForSlot(), ilGlobalCache\getInstance(), and ilPluginAdmin\getPluginObject().

Referenced by __construct().

     {
         require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');
         $ilGlobalCache = ilGlobalCache::getInstance(ilGlobalCache::COMP_EVENTS);
         $cached_listeners = $ilGlobalCache->get('listeners');
         if (is_array($cached_listeners)) {
             $this->listener = $cached_listeners;
 
             return;
         }
 
         $ilDB = $this->db;
 
         $this->listener = array();
 
         $sql = "SELECT * FROM il_event_handling" .
             " WHERE type = " . $ilDB->quote("listen", "text");
         $res = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($res)) {
             $this->listener[$row["id"]][] = $row["component"];
         }
 
         $ilGlobalCache->set('listeners', $this->listener);
     }