[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} extracts
  16   * data from an object
  17   */
  18  class ExtractEvent extends Event
  19  {
  20      const EVENT_EXTRACT = 'extract';
  21  
  22      /**
  23       * {@inheritDoc}
  24       */
  25      protected $name = self::EVENT_EXTRACT;
  26  
  27      /**
  28       * @var object
  29       */
  30      protected $extractionObject;
  31  
  32      /**
  33       * @var array
  34       */
  35      protected $extractedData = array();
  36  
  37      /**
  38       * @param object $target
  39       * @param object $extractionObject
  40       */
  41      public function __construct($target, $extractionObject)
  42      {
  43          $this->target           = $target;
  44          $this->extractionObject = $extractionObject;
  45      }
  46  
  47      /**
  48       * Retrieves the object from which data is extracted
  49       *
  50       * @return object
  51       */
  52      public function getExtractionObject()
  53      {
  54          return $this->extractionObject;
  55      }
  56  
  57      /**
  58       * @param object $extractionObject
  59       *
  60       * @return void
  61       */
  62      public function setExtractionObject($extractionObject)
  63      {
  64          $this->extractionObject = $extractionObject;
  65      }
  66  
  67      /**
  68       * Retrieves the data that has been extracted
  69       *
  70       * @return array
  71       */
  72      public function getExtractedData()
  73      {
  74          return $this->extractedData;
  75      }
  76  
  77      /**
  78       * @param array $extractedData
  79       *
  80       * @return void
  81       */
  82      public function setExtractedData(array $extractedData)
  83      {
  84          $this->extractedData = $extractedData;
  85      }
  86  
  87      /**
  88       * Merge provided data with the extracted data
  89       *
  90       * @param array $additionalData
  91       *
  92       * @return void
  93       */
  94      public function mergeExtractedData(array $additionalData)
  95      {
  96          $this->extractedData = array_merge($this->extractedData, $additionalData);
  97      }
  98  }