interface/modules/zend_modules/library/Zend/Stdlib/Hydrator/Aggregate/HydrateEvent.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\Stdlib\Hydrator\Aggregate;
  11
  12
  13 use Zend\EventManager\Event;
  14
  15 /**
  16  * Event triggered when the {@see \Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator} hydrates
  17  * data into an object
  18  */
  19 class HydrateEvent extends Event
  20 {
  21     const EVENT_HYDRATE = 'hydrate';
  22
  23     /**
  24      * {@inheritDoc}
  25      */
  26     protected $name = self::EVENT_HYDRATE;
  27
  28     /**
  29      * @var object
  30      */
  31     protected $hydratedObject;
  32
  33     /**
  34      * @var array
  35      */
  36     protected $hydrationData;
  37
  38     /**
  39      * @param object $target
  40      * @param object $hydratedObject
  41      * @param array  $hydrationData
  42      */
  43     public function __construct($target, $hydratedObject, array $hydrationData)
  44     {
  45         $this->target         = $target;
  46         $this->hydratedObject = $hydratedObject;
  47         $this->hydrationData  = $hydrationData;
  48     }
  49
  50     /**
  51      * Retrieves the object that is being hydrated
  52      *
  53      * @return object
  54      */
  55     public function getHydratedObject()
  56     {
  57         return $this->hydratedObject;
  58     }
  59
  60     /**
  61      * @param object $hydratedObject
  62      */
  63     public function setHydratedObject($hydratedObject)
  64     {
  65         $this->hydratedObject = $hydratedObject;
  66     }
  67
  68     /**
  69      * Retrieves the data that is being used for hydration
  70      *
  71      * @return array
  72      */
  73     public function getHydrationData()
  74     {
  75         return $this->hydrationData;
  76     }
  77
  78     /**
  79      * @param array $hydrationData
  80      */
  81     public function setHydrationData(array $hydrationData)
  82     {
  83         $this->hydrationData = $hydrationData;
  84     }
  85 }