gyro/core/lib/interfaces/ieventsource.cls.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * Something issuing events
00004  * 
00005  * @author Gerd Riesselmann
00006  * @ingroup Interfaces
00007  */
00008 interface IEventSource {
00009         /**
00010          * Triggers events
00011          * 
00012          * Events can be anything, and they are invoked through the router
00013          * One event is "cron", it has no parameters
00014          * 
00015          * @param string Event name
00016          * @param mixed Event parameter(s)
00017          * @return Status
00018          */
00019         public function invoke_event($event_name, $event_params, &$result);
00020 
00021         /**
00022          * Invokes an event without result
00023          *
00024          * @param string $event_name
00025          * @param mixed $event_params
00026          * @return status
00027          */
00028         public function invoke_event_no_result($event_name, $event_params);
00029 }