[Summary view] [Print] [Text view]

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