interface/modules/zend_modules/library/Zend/EventManager/EventInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\EventManager;
  11
  12 use ArrayAccess;
  13
  14 /**
  15  * Representation of an event
  16  */
  17 interface EventInterface
  18 {
  19     /**
  20      * Get event name
  21      *
  22      * @return string
  23      */
  24     public function getName();
  25
  26     /**
  27      * Get target/context from which event was triggered
  28      *
  29      * @return null|string|object
  30      */
  31     public function getTarget();
  32
  33     /**
  34      * Get parameters passed to the event
  35      *
  36      * @return array|ArrayAccess
  37      */
  38     public function getParams();
  39
  40     /**
  41      * Get a single parameter by name
  42      *
  43      * @param  string $name
  44      * @param  mixed $default Default value to return if parameter does not exist
  45      * @return mixed
  46      */
  47     public function getParam($name, $default = null);
  48
  49     /**
  50      * Set the event name
  51      *
  52      * @param  string $name
  53      * @return void
  54      */
  55     public function setName($name);
  56
  57     /**
  58      * Set the event target/context
  59      *
  60      * @param  null|string|object $target
  61      * @return void
  62      */
  63     public function setTarget($target);
  64
  65     /**
  66      * Set event parameters
  67      *
  68      * @param  string $params
  69      * @return void
  70      */
  71     public function setParams($params);
  72
  73     /**
  74      * Set a single parameter by key
  75      *
  76      * @param  string $name
  77      * @param  mixed $value
  78      * @return void
  79      */
  80     public function setParam($name, $value);
  81
  82     /**
  83      * Indicate whether or not the parent EventManagerInterface should stop propagating events
  84      *
  85      * @param  bool $flag
  86      * @return void
  87      */
  88     public function stopPropagation($flag = true);
  89
  90     /**
  91      * Has this event indicated event propagation should stop?
  92      *
  93      * @return bool
  94      */
  95     public function propagationIsStopped();
  96 }