CS fixes and docblocks for the aggregate hydrator namespace

library/Zend/Stdlib/Hydrator/Aggregate/AggregateHydrator.php

@@ -16,6 +16,9 @@
 use Zend\Stdlib\Hydrator\Filter\FilterComposite;
 use Zend\Stdlib\Hydrator\HydratorInterface;
 
+/**
+ * Aggregate hydrator that composes multiple hydrators via events
+ */
 class AggregateHydrator implements HydratorInterface, EventManagerAwareInterface
 {
     const DEFAULT_PRIORITY = 1;
@@ -25,6 +28,12 @@ class AggregateHydrator implements HydratorInterface, EventManagerAwareInterface
      */
     protected $eventManager;
 
+    /**
+     * Attaches the provided hydrator to the list of hydrators to be used while hydrating/extracting data
+     *
+     * @param \Zend\Stdlib\Hydrator\HydratorInterface $hydrator
+     * @param int                                     $priority
+     */
     public function add(HydratorInterface $hydrator, $priority = self::DEFAULT_PRIORITY)
     {
         $this->getEventManager()->attachAggregate(new HydratorListener($hydrator), $priority);

library/Zend/Stdlib/Hydrator/Aggregate/ExtractEvent.php

@@ -11,8 +11,11 @@
 
 
 use Zend\EventManager\Event;
-use Zend\Stdlib\ArrayUtils;
 
+/**
+ * Event triggered when the {@see \Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator} extracts
+ * data from an object
+ */
 class ExtractEvent extends Event
 {
     const EVENT_EXTRACT = 'extract';
@@ -32,34 +35,65 @@ class ExtractEvent extends Event
      */
     protected $extractedData = array();
 
+    /**
+     * @param object $target
+     * @param object $extractionObject
+     */
     public function __construct($target, $extractionObject)
     {
         $this->target           = $target;
         $this->extractionObject = $extractionObject;
     }
 
+    /**
+     * Retrieves the object from which data is extracted
+     *
+     * @return object
+     */
     public function getExtractionObject()
     {
         return $this->extractionObject;
     }
 
+    /**
+     * @param object $extractionObject
+     *
+     * @return void
+     */
     public function setExtractionObject($extractionObject)
     {
         $this->extractionObject = $extractionObject;
     }
 
+    /**
+     * Retrieves the data that has been extracted
+     *
+     * @return array
+     */
     public function getExtractedData()
     {
         return $this->extractedData;
     }
 
+    /**
+     * @param array $extractedData
+     *
+     * @return void
+     */
     public function setExtractedData(array $extractedData)
     {
         $this->extractedData = $extractedData;
     }
 
+    /**
+     * Merge provided data with the extracted data
+     *
+     * @param array $additionalData
+     *
+     * @return void
+     */
     public function mergeExtractedData(array $additionalData)
     {
         $this->extractedData = array_merge($this->extractedData, $additionalData);
     }
-}
+}

library/Zend/Stdlib/Hydrator/Aggregate/HydrateEvent.php

@@ -12,6 +12,10 @@
 
 use Zend\EventManager\Event;
 
+/**
+ * Event triggered when the {@see \Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator} hydrates
+ * data into an object
+ */
 class HydrateEvent extends Event
 {
     const EVENT_HYDRATE = 'hydrate';
@@ -31,30 +35,51 @@ class HydrateEvent extends Event
      */
     protected $hydrationData;
 
+    /**
+     * @param object $target
+     * @param object $hydratedObject
+     * @param array  $hydrationData
+     */
     public function __construct($target, $hydratedObject, array $hydrationData)
     {
         $this->target         = $target;
         $this->hydratedObject = $hydratedObject;
         $this->hydrationData  = $hydrationData;
     }
 
+    /**
+     * Retrieves the object that is being hydrated
+     *
+     * @return object
+     */
     public function getHydratedObject()
     {
         return $this->hydratedObject;
     }
 
+    /**
+     * @param object $hydratedObject
+     */
     public function setHydratedObject($hydratedObject)
     {
         $this->hydratedObject = $hydratedObject;
     }
 
+    /**
+     * Retrieves the data that is being used for hydration
+     *
+     * @return array
+     */
     public function getHydrationData()
     {
         return $this->hydrationData;
     }
 
+    /**
+     * @param array $hydrationData
+     */
     public function setHydrationData(array $hydrationData)
     {
         $this->hydrationData = $hydrationData;
     }
-}
+}

library/Zend/Stdlib/Hydrator/Aggregate/HydratorListener.php

@@ -14,6 +14,11 @@
 use Zend\EventManager\EventManagerInterface;
 use Zend\Stdlib\Hydrator\HydratorInterface;
 
+/**
+ * Aggregate listener wrapping around a hydrator. Listens
+ * to {@see \Zend\Stdlib\Hydrator\Aggregate::EVENT_HYDRATE} and
+ * {@see \Zend\Stdlib\Hydrator\Aggregate::EVENT_EXTRACT}
+ */
 class HydratorListener extends AbstractListenerAggregate
 {
     /**
@@ -39,6 +44,12 @@ public function attach(EventManagerInterface $events)
     }
 
     /**
+     * Callback to be used when {@see \Zend\Stdlib\Hydrator\Aggregate\HydrateEvent::EVENT_HYDRATE} is triggered
+     *
+     * @param \Zend\Stdlib\Hydrator\Aggregate\HydrateEvent $event
+     *
+     * @return object
+     *
      * @internal
      */
     public function onHydrate(HydrateEvent $event)
@@ -51,6 +62,12 @@ public function onHydrate(HydrateEvent $event)
     }
 
     /**
+     * Callback to be used when {@see \Zend\Stdlib\Hydrator\Aggregate\ExtractEvent::EVENT_EXTRACT} is triggered
+     *
+     * @param \Zend\Stdlib\Hydrator\Aggregate\ExtractEvent $event
+     *
+     * @return array
+     *
      * @internal
      */
     public function onExtract(ExtractEvent $event)

tests/ZendTest/Stdlib/Hydrator/Aggregate/AggregateHydratorFunctionalTest.php

@@ -175,4 +175,4 @@ public function getHydratorSet()
             array(new ArraySerializable(), new ArrayObject(array('zaphod' => 'beeblebrox')), array('arthur' => 'dent')),
         );
     }
-}
+}

tests/ZendTest/Stdlib/Hydrator/Aggregate/AggregateHydratorTest.php

@@ -13,6 +13,9 @@
 use Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator;
 use stdClass;
 
+/**
+ * Unit tests for {@see \Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator}
+ */
 class AggregateHydratorTest extends PHPUnit_Framework_TestCase
 {
     /**

tests/ZendTest/Stdlib/Hydrator/Aggregate/ExtractEventTest.php

@@ -53,4 +53,4 @@ public function testEvent()
         $this->assertSame('Marvin', $extracted['maintainer']);
         $this->assertSame('Zaphod', $extracted['president']);
     }
-}
+}

tests/ZendTest/Stdlib/Hydrator/Aggregate/HydrateEventTest.php

@@ -45,4 +45,4 @@ public function testEvent()
 
         $this->assertSame($hydrated2, $event->getHydratedObject());
     }
-}
+}

tests/ZendTest/Stdlib/Hydrator/Aggregate/HydratorListenerTest.php

@@ -115,4 +115,4 @@ public function testOnExtract()
 
         $this->assertSame($data, $this->listener->onExtract($event));
     }
-}
+}