interface/modules/zend_modules/library/Zend/Stdlib/Hydrator/Aggregate/HydratorListener.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\AbstractListenerAggregate;
  14 use Zend\EventManager\EventManagerInterface;
  15 use Zend\Stdlib\Hydrator\HydratorInterface;
  16
  17 /**
  18  * Aggregate listener wrapping around a hydrator. Listens
  19  * to {@see \Zend\Stdlib\Hydrator\Aggregate::EVENT_HYDRATE} and
  20  * {@see \Zend\Stdlib\Hydrator\Aggregate::EVENT_EXTRACT}
  21  */
  22 class HydratorListener extends AbstractListenerAggregate
  23 {
  24     /**
  25      * @var \Zend\Stdlib\Hydrator\HydratorInterface
  26      */
  27     protected $hydrator;
  28
  29     /**
  30      * @param \Zend\Stdlib\Hydrator\HydratorInterface $hydrator
  31      */
  32     public function __construct(HydratorInterface $hydrator)
  33     {
  34         $this->hydrator = $hydrator;
  35     }
  36
  37     /**
  38      * {@inheritDoc}
  39      */
  40     public function attach(EventManagerInterface $events, $priority = 1)
  41     {
  42         $this->listeners[] = $events->attach(HydrateEvent::EVENT_HYDRATE, array($this, 'onHydrate'), $priority);
  43         $this->listeners[] = $events->attach(ExtractEvent::EVENT_EXTRACT, array($this, 'onExtract'), $priority);
  44     }
  45
  46     /**
  47      * Callback to be used when {@see \Zend\Stdlib\Hydrator\Aggregate\HydrateEvent::EVENT_HYDRATE} is triggered
  48      *
  49      * @param \Zend\Stdlib\Hydrator\Aggregate\HydrateEvent $event
  50      *
  51      * @return object
  52      *
  53      * @internal
  54      */
  55     public function onHydrate(HydrateEvent $event)
  56     {
  57         $object = $this->hydrator->hydrate($event->getHydrationData(), $event->getHydratedObject());
  58
  59         $event->setHydratedObject($object);
  60
  61         return $object;
  62     }
  63
  64     /**
  65      * Callback to be used when {@see \Zend\Stdlib\Hydrator\Aggregate\ExtractEvent::EVENT_EXTRACT} is triggered
  66      *
  67      * @param \Zend\Stdlib\Hydrator\Aggregate\ExtractEvent $event
  68      *
  69      * @return array
  70      *
  71      * @internal
  72      */
  73     public function onExtract(ExtractEvent $event)
  74     {
  75         $data = $this->hydrator->extract($event->getExtractionObject());
  76
  77         $event->mergeExtractedData($data);
  78
  79         return $data;
  80     }
  81 }