interface/modules/zend_modules/library/Zend/Db/TableGateway/Feature/EventFeature/TableGatewayEvent.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\Db\TableGateway\Feature\EventFeature;
  11
  12 use Zend\Db\TableGateway\AbstractTableGateway;
  13 use Zend\EventManager\EventInterface;
  14
  15 class TableGatewayEvent implements EventInterface
  16 {
  17
  18     /**
  19      * @var AbstractTableGateway
  20      */
  21     protected $target = null;
  22
  23     /**
  24      * @var null
  25      */
  26     protected $name = null;
  27
  28     /**
  29      * @var array|\ArrayAccess
  30      */
  31     protected $params = array();
  32
  33     /**
  34      * Get event name
  35      *
  36      * @return string
  37      */
  38     public function getName()
  39     {
  40         return $this->name;
  41     }
  42
  43     /**
  44      * Get target/context from which event was triggered
  45      *
  46      * @return null|string|object
  47      */
  48     public function getTarget()
  49     {
  50         return $this->target;
  51     }
  52
  53     /**
  54      * Get parameters passed to the event
  55      *
  56      * @return array|\ArrayAccess
  57      */
  58     public function getParams()
  59     {
  60         return $this->params;
  61     }
  62
  63     /**
  64      * Get a single parameter by name
  65      *
  66      * @param  string $name
  67      * @param  mixed $default Default value to return if parameter does not exist
  68      * @return mixed
  69      */
  70     public function getParam($name, $default = null)
  71     {
  72         return (isset($this->params[$name]) ? $this->params[$name] : $default);
  73     }
  74
  75     /**
  76      * Set the event name
  77      *
  78      * @param  string $name
  79      * @return void
  80      */
  81     public function setName($name)
  82     {
  83         $this->name = $name;
  84     }
  85
  86     /**
  87      * Set the event target/context
  88      *
  89      * @param  null|string|object $target
  90      * @return void
  91      */
  92     public function setTarget($target)
  93     {
  94         $this->target = $target;
  95     }
  96
  97     /**
  98      * Set event parameters
  99      *
 100      * @param  string $params
 101      * @return void
 102      */
 103     public function setParams($params)
 104     {
 105         $this->params = $params;
 106     }
 107
 108     /**
 109      * Set a single parameter by key
 110      *
 111      * @param  string $name
 112      * @param  mixed $value
 113      * @return void
 114      */
 115     public function setParam($name, $value)
 116     {
 117         $this->params[$name] = $value;
 118     }
 119
 120     /**
 121      * Indicate whether or not the parent EventManagerInterface should stop propagating events
 122      *
 123      * @param  bool $flag
 124      * @return void
 125      */
 126     public function stopPropagation($flag = true)
 127     {
 128         return;
 129     }
 130
 131     /**
 132      * Has this event indicated event propagation should stop?
 133      *
 134      * @return bool
 135      */
 136     public function propagationIsStopped()
 137     {
 138         return false;
 139     }
 140 }