Controller events

src/ZfrRest/Mvc/Controller/AbstractRestfulController.php

@@ -20,8 +20,6 @@
 
 use Doctrine\Common\Collections\Collection;
 use Zend\Http\Request as HttpRequest;
-use Zend\InputFilter\InputFilterInterface;
-use Zend\InputFilter\InputFilterPluginManager;
 use Zend\Mvc\Controller\AbstractController;
 use Zend\Mvc\MvcEvent;
 use Zend\Paginator\Paginator;
@@ -48,25 +46,6 @@ class AbstractRestfulController extends AbstractController
      */
     protected $methodHandlerManager;
 
-    /**
-     * If this is set to true, then controller will automatically instantiate the input filter specified in
-     * resource metadata (if there is one) - from service locator first, or directly instantiate it if not found -,
-     * and validate data. If data is incorrect, it will return a 400 HTTP error (Bad Request) with the failed
-     * validation messages in it).
-     *
-     * @var bool
-     */
-    protected $autoValidate = true;
-
-    /**
-     * If this is set to true, then controller will automatically instantiate the hydrator specified in resource
-     * metadata (if there is one) - from service locator first, or directly instantiate it if not found - and
-     * hydrate resource object with previously validated data
-     *
-     * @var bool
-     */
-    protected $autoHydrate = true;
-
     /**
      * {@inheritDoc}
      */
@@ -133,36 +112,4 @@ public function getMethodHandlerManager()
 
         return $this->methodHandlerManager;
     }
-
-    /**
-     * Hook to configure an input filter fetched/created by ZfrRest
-     *
-     * @param  InputFilterPluginManager $inputFilterPluginManager
-     * @param  string                   $inputFilterName
-     * @return InputFilterInterface
-     */
-    public function getInputFilter(InputFilterPluginManager $inputFilterPluginManager, $inputFilterName)
-    {
-        return $inputFilterPluginManager->get($inputFilterName);
-    }
-
-    /**
-     * Should auto validate?
-     *
-     * @return bool
-     */
-    public function getAutoValidate()
-    {
-        return $this->autoValidate;
-    }
-
-    /**
-     * Should auto hydrate?
-     *
-     * @return bool
-     */
-    public function getAutoHydrate()
-    {
-        return $this->autoHydrate;
-    }
 }

src/ZfrRest/Mvc/Controller/Event/HydrationEvent.php

@@ -0,0 +1,115 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+namespace ZfrRest\Mvc\Controller\Event;
+
+use Zend\EventManager\Event;
+use Zend\Stdlib\Hydrator\HydratorInterface;
+use Zend\Stdlib\Hydrator\HydratorPluginManager;
+use ZfrRest\Resource\ResourceInterface;
+
+/**
+ * @author  Daniel Gimenes <daniel@danielgimenes.com.br>
+ * @licence MIT
+ */
+class HydrationEvent extends Event
+{
+    /**
+     * Event names
+     */
+    const EVENT_HYDRATE_PRE  = 'hydrate.pre';
+    const EVENT_HYDRATE_POST = 'hydrate.post';
+
+    /**
+     * @var bool
+     */
+    protected $autoHydrate = true;
+
+    /**
+     * @var ResourceInterface
+     */
+    protected $resource;
+
+    /**
+     * @var HydratorPluginManager
+     */
+    protected $hydratorManager;
+
+    /**
+     * @var null|HydratorInterface
+     */
+    protected $hydrator;
+
+    /**
+     * @param ResourceInterface     $resource
+     * @param HydratorPluginManager $hydratorManager
+     */
+    public function __construct(ResourceInterface $resource, HydratorPluginManager $hydratorManager)
+    {
+        $this->resource        = $resource;
+        $this->hydratorManager = $hydratorManager;
+    }
+
+    /**
+     * @param bool $autoHydrate
+     */
+    public function setAutoHydrate($autoHydrate)
+    {
+        $this->autoHydrate = (bool) $autoHydrate;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getAutoHydrate()
+    {
+        return $this->autoHydrate;
+    }
+
+    /**
+     * @return ResourceInterface
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+
+    /**
+     * @return HydratorPluginManager
+     */
+    public function getHydratorManager()
+    {
+        return $this->hydratorManager;
+    }
+
+    /**
+     * @param HydratorInterface $hydrator
+     */
+    public function setHydrator(HydratorInterface $hydrator)
+    {
+        $this->hydrator = $hydrator;
+    }
+
+    /**
+     * @return null|HydratorInterface
+     */
+    public function getHydrator()
+    {
+        return $this->hydrator;
+    }
+}

src/ZfrRest/Mvc/Controller/Event/ValidationEvent.php

@@ -0,0 +1,116 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+namespace ZfrRest\Mvc\Controller\Event;
+
+use Zend\EventManager\Event;
+use Zend\InputFilter\InputFilterInterface;
+use Zend\InputFilter\InputFilterPluginManager;
+use ZfrRest\Resource\ResourceInterface;
+
+/**
+ * @author  Daniel Gimenes <daniel@danielgimenes.com.br>
+ * @licence MIT
+ */
+class ValidationEvent extends Event
+{
+    /**
+     * Event names
+     */
+    const EVENT_VALIDATE_PRE     = 'validate.pre';
+    const EVENT_VALIDATE_ERROR   = 'validate.error';
+    const EVENT_VALIDATE_SUCCESS = 'validate.success';
+
+    /**
+     * @var bool
+     */
+    protected $autoValidate = true;
+
+    /**
+     * @var ResourceInterface
+     */
+    protected $resource;
+
+    /**
+     * @var InputFilterPluginManager
+     */
+    protected $inputFilterManager;
+
+    /**
+     * @var null|InputFilterInterface
+     */
+    protected $inputFilter;
+
+    /**
+     * @param ResourceInterface        $resource
+     * @param InputFilterPluginManager $inputFilterManager
+     */
+    public function __construct(ResourceInterface $resource, InputFilterPluginManager $inputFilterManager)
+    {
+        $this->resource           = $resource;
+        $this->inputFilterManager = $inputFilterManager;
+    }
+
+    /**
+     * @param bool $autoValidate
+     */
+    public function setAutoValidate($autoValidate)
+    {
+        $this->autoValidate = (bool) $autoValidate;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getAutoValidate()
+    {
+        return $this->autoValidate;
+    }
+
+    /**
+     * @return ResourceInterface
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+
+    /**
+     * @return InputFilterPluginManager
+     */
+    public function getInputFilterManager()
+    {
+        return $this->inputFilterManager;
+    }
+
+    /**
+     * @param InputFilterInterface $inputFilter
+     */
+    public function setInputFilter(InputFilterInterface $inputFilter)
+    {
+        $this->inputFilter = $inputFilter;
+    }
+
+    /**
+     * @return null|InputFilterInterface
+     */
+    public function getInputFilter()
+    {
+        return $this->inputFilter;
+    }
+}

src/ZfrRest/Mvc/Controller/MethodHandler/DataHydrationTrait.php

@@ -18,7 +18,10 @@
 
 namespace ZfrRest\Mvc\Controller\MethodHandler;
 
+use Zend\EventManager\EventManagerAwareInterface;
+use Zend\Stdlib\Hydrator\HydratorInterface;
 use Zend\Stdlib\Hydrator\HydratorPluginManager;
+use ZfrRest\Mvc\Controller\Event\HydrationEvent;
 use ZfrRest\Mvc\Exception\RuntimeException;
 use ZfrRest\Resource\ResourceInterface;
 
@@ -38,18 +41,40 @@ trait DataHydrationTrait
     /**
      * Hydrate the object bound to the data
      *
-     * @param  ResourceInterface $resource
-     * @param  array             $data
+     * @param  ResourceInterface          $resource
+     * @param  array                      $data
+     * @param  EventManagerAwareInterface $controller
      * @return array|object
      * @throws RuntimeException
      */
-    public function hydrateData(ResourceInterface $resource, array $data)
+    public function hydrateData(ResourceInterface $resource, array $data, EventManagerAwareInterface $controller)
     {
-        if (!($hydratorName = $resource->getMetadata()->getHydratorName())) {
-            throw new RuntimeException('No hydrator name has been found in resource metadata');
+        /* @var EventManagerInterface $eventManager */
+        $eventManager = $controller->getEventManager();
+
+        $event = new HydrationEvent($resource, $this->hydratorPluginManager);
+        $event->setTarget($controller);
+
+        $eventManager->trigger(HydrationEvent::EVENT_HYDRATE_PRE, $event);
+
+        if (!$event->getAutoHydrate()) {
+            return $data;
+        }
+
+        /* @var HydratorInterface $inputFilter */
+        $hydrator = $event->getHydrator();
+
+        if (!$hydrator instanceof HydratorInterface) {
+            if (!($hydratorName = $resource->getMetadata()->getHydratorName())) {
+                throw new RuntimeException('No hydrator name has been found in resource metadata');
+            }
+
+            $hydrator = $this->hydratorPluginManager->get($hydratorName);
+
+            $event->setHydrator($hydrator);
         }
 
-        $hydrator = $this->hydratorPluginManager->get($hydratorName);
+        $eventManager->trigger(HydrationEvent::EVENT_HYDRATE_POST, $event);
 
         return $hydrator->hydrate($data, $resource->getData());
     }