tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Source for file web_events_dispatcher.class.php

Documentation is available at web_events_dispatcher.class.php

  1. <?php
  2. // *** Tangra (Application Framework and Tools for PHP)
  3. //  $Id$
  4. //
  5.  
  6. /**
  7.  * Contains class Web_Events_Dispatcher
  8.  *
  9.  * @package tangra_lib
  10.  * @subpackage  web_site
  11.  */
  12.  
  13. /**
  14.  *
  15.  */
  16. require_once(TANGRA_MAIN_DIR.'exceptions/te_key_already_exists.class.php');
  17. /**
  18.  *
  19.  */
  20. require_once(TANGRA_MAIN_DIR.'web_site/web_event_composite.class.php');
  21.  
  22. /**
  23.  * Web_Event_Dispatcher is responsible for monitoring occurence of
  24.  * Web_Events and dispatching of program flow
  25.  *
  26.  * @package tangra_lib
  27.  * @subpackage  web_site
  28.  */
  29. class Web_Event_Dispatcher extends Tangra_Class {
  30.     /**
  31.      * Reference to Web_page object
  32.      *
  33.      * @var Web_page 
  34.      * @internal
  35.      */
  36.     private $page_pointer;
  37.     /**
  38.      * Default event-action pair
  39.      *
  40.      * @var unknown_type 
  41.      * @internal
  42.      */
  43.     private $default_event_action_pair;
  44.     /**
  45.      * Array containing event-action pairs
  46.      *
  47.      * @var array 
  48.      * @internal
  49.      */
  50.     private $event_action_pairs = array();
  51.     /**
  52.      * Array that contains prioritetes of events
  53.      *
  54.      * @var array 
  55.      * @internal
  56.      */
  57.     private $order_arr = array();
  58.  
  59.     /**
  60.      * Constructor
  61.      *
  62.      * @param Web_Page $page_pointer Page that instantiates this object
  63.      */
  64.     function __construct(Web_Page $page_pointer) {
  65.         $this->page_pointer = $page_pointer;
  66.     }
  67.  
  68.  
  69.     /**
  70.      * Sets default event-action pair
  71.      *
  72.      * @param Web_Event $we 
  73.      * @param string $target_method Name of the Web_Page method that will be triggered if event occures
  74.      */
  75.     function set_default_event_action_pair(Web_Event $we, $target_method) {
  76.         $this->default_event_action_pair['event'] = $we;
  77.         $this->default_event_action_pair['target'] = $target_method;
  78.     }
  79.  
  80.  
  81.     /**
  82.      * Adds new event-action pair
  83.      *
  84.      * @param Web_Event $we 
  85.      * @param unknown_type $target_method Name of the Web_Page method that will be triggered if event occures
  86.      * @param integer $order Order of this event. Events will be evaluated  ordered by their $order.
  87.      * @throws Tangra_Exception, TE_Key_Already_Exists
  88.      */
  89.     public function add_wed_event_action_pair(Web_Event $we, $target_method, $order = 10) {
  90.         tangra_if_not_int_throw_e($order);
  91.         if (!array_key_exists($we->get_name(), $this->event_action_pairs)) {
  92.             if (method_exists($this->page_pointer, $target_method)) {
  93.                 $this->event_action_pairs[$we->get_name()] = array('event' => $we, 'target' => $target_method);
  94.                 $this->order_arr[$we->get_name()] = $order;
  95.                 asort($this->order_arr);
  96.             } else {
  97.                 throw new Tangra_Exception('Method not callable: '.$target_method);
  98.             }
  99.         } else {
  100.             throw new TE_Key_Already_Exists($we->get_name());
  101.         }
  102.     }
  103.  
  104.     /**
  105.      * Returns array dispatch direction
  106.      *
  107.      * Returns array:
  108.      * ['target'] - action of the event, method that will be triggered
  109.      * ['param'] - captured value/array of values
  110.      *
  111.      * @param Web_Context $context 
  112.      * @return array 
  113.      */
  114.     public function get_dispatch(Web_Context $context) {
  115.  
  116.         $ret = false;
  117.  
  118.         foreach($this->order_arr as $ev_name => $order) {
  119.             $ea_pair = $this->event_action_pairs[$ev_name];
  120.             $param = $ea_pair['event']->is_it_me($context);
  121.             if ($param !== false) {
  122.                 $ret['target'] = $ea_pair['target'];
  123.                 $ret['param'] = $param;
  124.                 break;
  125.             }
  126.         }
  127.  
  128.         if (!$ret) {
  129.             $ret['target'] = $this->default_event_action_pair['target'];
  130.             $ret['param'] = NULL;
  131.         }
  132.  
  133.         return $ret;
  134.     }
  135.  
  136.  
  137.     /**
  138.      * Checks if there are duplicate captures
  139.      *
  140.      * @return string Capture label
  141.      */
  142.     public function check_for_duplicate_captures() {
  143.         $ret = false;
  144.  
  145.         $tmp_arr = array();
  146.  
  147.         foreach($this->event_action_pairs as $eap) {
  148.             $tmp_capture = $eap['event']->get_capture();
  149.             if (is_array($tmp_capture)) { //composite event
  150.                 foreach($tmp_capture as $capture) {
  151.                     if (!array_key_exists($capture, $tmp_arr)) {
  152.                         $tmp_arr[$capture] = $capture;
  153.                     } else {
  154.                         $ret = $capture;
  155.                         break 2;
  156.                     }
  157.                 }
  158.             } else { //simple event
  159.                 if (!array_key_exists($tmp_capture, $tmp_arr)) {
  160.                     $tmp_arr[$tmp_capture] = $tmp_capture;
  161.                 } else {
  162.                     $ret = $tmp_capture;
  163.                     break;
  164.                 }
  165.             }
  166.         }
  167.  
  168.         return $ret;
  169.     }
  170.  
  171.  
  172.     /**
  173.      * Checks if event with name <var>$event_name</var> is already registered
  174.      *
  175.      * @param unknown_type $event_name 
  176.      * @return boolean 
  177.      */
  178.     public function is_event_registered($event_name) {
  179.         return array_key_exists($event_name, $this->event_action_pairs);
  180.     }
  181.  
  182.  
  183.     /**
  184.      * Returns event action pairs
  185.      *
  186.      * @return array 
  187.      */
  188.     public function get_event_action_pairs() {
  189.         return $this->event_action_pairs;
  190.     }
  191. }