ilAppEventHandler Class Reference

Global event handler. More...

Collaboration diagram for ilAppEventHandler:

Public Member Functions
	__construct ()
	Constructor. More...
	raise ($a_component, $a_event, $a_parameter="")
	Raise an event. More...

Protected Member Functions
	initListeners ()

Protected Attributes
	$db
	$listener

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 58 of file class.ilAppEventHandler.php.

Constructor & Destructor Documentation

__construct()

ilAppEventHandler::__construct

(

)

Constructor.

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

References $DIC, and initListeners().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->initListeners();
    }

Here is the call graph for this function:

Member Function Documentation

initListeners()

ilAppEventHandler::initListeners ( )

protected

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

References $db, $ilDB, $res, $row, array, ilGlobalCache\COMP_EVENTS, and ilGlobalCache\getInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

raise()

ilAppEventHandler::raise	(		$a_component,
			$a_event,
			$a_parameter = ""
	)

Raise an event.

The event is passed to all interested listeners.

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...)

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

References $file, $listener, $name, array, ilPluginAdmin\getActivePlugins(), ilPluginAdmin\getActivePluginsForSlot(), and ilPluginAdmin\getPluginObject().

    {
        if (is_array($this->listener[$a_component])) {
            foreach ($this->listener[$a_component] as $listener) {
                // Allow listeners like Services/WebServices/ECS
                $last_slash = strripos($listener, '/');
                $comp = substr($listener, 0, $last_slash);

                // any kind of plugins with events in their plugin.xml
                if ($comp == 'Plugins') {
                    $name = substr($listener, $last_slash + 1);

                    foreach (ilPluginAdmin::getActivePlugins() as $pdata) {
                        if ($pdata['name'] == $name) {
                            $plugin = ilPluginAdmin::getPluginObject(
                                $pdata['component_type'],
                                $pdata['component_name'],
                                $pdata['slot_id'],
                                $pdata['name']
                            );

                            $plugin->handleEvent($a_component, $a_event, $a_parameter);
                        }
                    }
                } else {
                    $class = 'il' . substr($listener, $last_slash + 1) . 'AppEventListener';
                    $file = "./" . $listener . "/classes/class." . $class . ".php";

                    // if file exists, call listener
                    if (is_file($file)) {
                        include_once($file);
                        call_user_func(array($class, 'handleEvent'), $a_component, $a_event, $a_parameter);
                    }
                }
            }
        }

        // get all event hook plugins and forward the event to them
        include_once("./Services/Component/classes/class.ilPluginAdmin.php");
        $plugins = ilPluginAdmin::getActivePluginsForSlot("Services", "EventHandling", "evhk");
        foreach ($plugins as $pl) {
            $plugin = ilPluginAdmin::getPluginObject(
                "Services",
                "EventHandling",
                "evhk",
                $pl
            );
            $plugin->handleEvent($a_component, $a_event, $a_parameter);
        }

        $workflow_engine = new ilWorkflowEngine(false);
        $workflow_engine->handleEvent($a_component, $a_event, $a_parameter);
    }

Here is the call graph for this function:

Field Documentation

$db

ilAppEventHandler::$db

protected

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

Referenced by initListeners().

$listener

ilAppEventHandler::$listener

protected

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

Referenced by raise().

---

The documentation for this class was generated from the following file:

• Services/EventHandling/classes/class.ilAppEventHandler.php