Merge pull request #150 from TomHAnderson/feature/create-filter

Added Query Create Filters

README.md

@@ -188,3 +188,32 @@ When the query provider is registered attach it to the doctrine-connected resour
     ),
 ),
 ```
+
+Query Create Filters
+==============
+
+In order to filter or change data sent to a create statement before it is used to hydrate the entity you may use a query create filter.  Create filters are very similar to Query Providers in their implementation.  
+
+Create filters take the data as a paramter and return the data, modified or filtered.
+
+A custom plugin manager is available to register your own create filters.  This can be done through following configuration:
+
+```php
+'zf-apigility-doctrine-query-create-filter' => array(
+    'invokables' => array(
+        'entity_name' => 'Application\Query\CreateFilter\EntityName',
+    )
+),
+```
+
+Register your Query Create Filter as:
+```php
+'zf-apigility' => array(
+    'doctrine-connected' => array(
+        'Api\\V1\\Rest\\....' => array(
+            'query_create_filter' => 'entity_name',
+            ...
+        ),
+    ),
+),
+```

config/server.config.php

@@ -16,6 +16,8 @@
         'factories' => array(
             'ZfApigilityDoctrineQueryProviderManager' =>
                 'ZF\Apigility\Doctrine\Server\Query\Provider\Service\QueryProviderManagerFactory',
+            'ZfApigilityDoctrineQueryCreateFilterManager' =>
+                'ZF\Apigility\Doctrine\Server\Query\CreateFilter\Service\QueryCreateFilterManagerFactory',
         ),
     ),
 
@@ -26,6 +28,12 @@
         )
     ),
 
+    'zf-apigility-doctrine-query-create-filter' => array(
+        'invokables' => array(
+            'default' => 'ZF\Apigility\Doctrine\Server\Query\CreateFilter\DefaultCreateFilter',
+        )
+    ),
+
     'view_manager' => array(
         'template_path_stack' => array(
             'zf-apigility-doctrine' => __DIR__ . '/../view',

src/Server/Module.php

@@ -38,6 +38,13 @@ public function init(ModuleManager $moduleManager)
             'ZF\Apigility\Doctrine\Server\Query\Provider\QueryProviderInterface',
             'getZfApigilityDoctrineQueryProviderConfig'
         );
+
+        $serviceListener->addServiceManager(
+            'ZfApigilityDoctrineQueryCreateFilterManager',
+            'zf-apigility-doctrine-query-create-filter',
+            'ZF\Apigility\Doctrine\Server\Query\CreateFilter\QueryCreateFilterInterface',
+            'getZfApigilityDoctrineQueryCreateFilterConfig'
+        );
     }
 
     /**

src/Server/Query/CreateFilter/DefaultCreateFilter.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace ZF\Apigility\Doctrine\Server\Query\CreateFilter;
+
+use ZF\Apigility\Doctrine\Server\Query\CreateFilter\QueryCreateFilterInterface;
+use DoctrineModule\Persistence\ObjectManagerAwareInterface;
+use Doctrine\Common\Persistence\ObjectManager;
+use ZF\ApiProblem\ApiProblem;
+use ZF\Rest\ResourceEvent;
+
+/**
+ * Class DefaultCreateFilter
+ *
+ * @package ZF\Apigility\Doctrine\Server\Query\CreateFilter
+ */
+class DefaultCreateFilter implements ObjectManagerAwareInterface, QueryCreateFilterInterface
+{
+    /**
+     * @var ObjectManager
+     */
+    protected $objectManager;
+
+    /**
+     * Set the object manager
+     *
+     * @param ObjectManager $objectManager
+     */
+    public function setObjectManager(ObjectManager $objectManager)
+    {
+        $this->objectManager = $objectManager;
+    }
+
+    /**
+     * Get the object manager
+     *
+     * @return ObjectManager
+     */
+    public function getObjectManager()
+    {
+        return $this->objectManager;
+    }
+
+    /**
+     * @param string $entityClass
+     * @param array  $data
+     *
+     * @return array
+     */
+    public function filter(ResourceEvent $event, $entityClass, $data)
+    {
+        return $data;
+    }
+}

src/Server/Query/CreateFilter/QueryCreateFilterInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ZF\Apigility\Doctrine\Server\Query\CreateFilter;
+
+use DoctrineModule\Persistence\ObjectManagerAwareInterface;
+use ZF\Rest\ResourceEvent;
+
+interface QueryCreateFilterInterface extends ObjectManagerAwareInterface
+{
+    /**
+     * @param string $entityClass
+     * @param array  $data
+     *
+     * @return array
+     */
+    public function filter(ResourceEvent $event, $entityClass, $data);
+}

src/Server/Query/CreateFilter/Service/QueryCreateFilterManager.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ZF\Apigility\Doctrine\Server\Query\CreateFilter\Service;
+
+use ZF\Apigility\Doctrine\Server\Query\CreateFilter\QueryCreateFilterInterface;
+use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\Exception;
+
+class QueryCreateFilterManager extends AbstractPluginManager
+{
+    protected $invokableClasses = array();
+
+    /**
+     * @param mixed $plugin
+     *
+     * @return void
+     * @throws Exception\RuntimeException
+     */
+    public function validatePlugin($plugin)
+    {
+        if ($plugin instanceof QueryCreateFilterInterface) {
+            // we're okay
+            return;
+        }
+
+        // @codeCoverageIgnoreStart
+        throw new Exception\RuntimeException(
+            sprintf(
+                'Plugin of type %s is invalid; must implement QueryCreateFilterInterface',
+                (is_object($plugin) ? get_class($plugin) : gettype($plugin))
+            )
+        );
+        // @codeCoverageIgnoreEnd
+    }
+}

src/Server/Query/CreateFilter/Service/QueryCreateFilterManagerFactory.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace ZF\Apigility\Doctrine\Server\Query\CreateFilter\Service;
+
+use Zend\Mvc\Service\AbstractPluginManagerFactory;
+
+class QueryCreateFilterManagerFactory extends AbstractPluginManagerFactory
+{
+    const PLUGIN_MANAGER_CLASS = 'ZF\Apigility\Doctrine\Server\Query\CreateFilter\Service\QueryCreateFilterManager';
+}

src/Server/Resource/DoctrineResource.php

@@ -21,6 +21,7 @@
 use Traversable;
 use Doctrine\ORM\NoResultException;
 use Doctrine\Common\Collections\ArrayCollection;
+use ZF\Apigility\Doctrine\Server\Query\CreateFilter\QueryCreateFilterInterface;
 
 /**
  * Class DoctrineResource
@@ -197,6 +198,24 @@ public function setEntityIdentifierName($value)
         return $this;
     }
 
+    /**
+     * @var QueryCreateFilterInterface
+     */
+    protected $queryCreateFilter;
+
+    public function setQueryCreateFilter(QueryCreateFilterInterface $value)
+    {
+        $this->queryCreateFilter = $value;
+
+        return $this;
+    }
+
+    public function getQueryCreateFilter()
+    {
+        return $this->queryCreateFilter;
+    }
+
+
     /**
      * @var string
      */
@@ -278,6 +297,12 @@ public function getHydrator()
     public function create($data)
     {
         $entityClass = $this->getEntityClass();
+
+        $data = $this->getQueryCreateFilter()->filter($this->getEvent(), $entityClass, $data);
+        if ($data instanceof ApiProblem) {
+            return $results->last();
+        }
+
         $entity = new $entityClass;
         $hydrator = $this->getHydrator();
         $hydrator->hydrate((array) $data, $entity);

src/Server/Resource/DoctrineResourceFactory.php

@@ -121,12 +121,14 @@ public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $
         $objectManager = $this->loadObjectManager($serviceLocator, $doctrineConnectedConfig);
         $hydrator = $this->loadHydrator($serviceLocator, $doctrineConnectedConfig, $objectManager);
         $queryProviders = $this->loadQueryProviders($serviceLocator, $doctrineConnectedConfig, $objectManager);
+        $queryCreateFilter = $this->loadQueryCreateFilter($serviceLocator, $doctrineConnectedConfig, $objectManager);
         $configuredListeners = $this->loadConfiguredListeners($serviceLocator, $doctrineConnectedConfig);
 
         $listener = new $className();
         $listener->setObjectManager($objectManager);
         $listener->setHydrator($hydrator);
         $listener->setQueryProviders($queryProviders);
+        $listener->setQueryCreateFilter($queryCreateFilter);
         $listener->setServiceManager($serviceLocator);
         $listener->setEntityIdentifierName($restConfig['entity_identifier_name']);
         if (count($configuredListeners)) {
@@ -192,6 +194,23 @@ protected function loadHydrator(ServiceLocatorInterface $serviceLocator, $config
         return $hydratorManager->get($config['hydrator']);
     }
 
+    /**
+     * @param ServiceLocatorInterface $serviceLocator
+     * @param                         $config
+     * @param                         $objectManager
+     *
+     * @return ZF\Apigility\Doctrine\Query\Provider\FetchAll\FetchAllQueryProviderInterface
+     * @throws \Zend\ServiceManager\Exception\ServiceNotCreatedException
+     */
+    protected function loadQueryCreateFilter(ServiceLocatorInterface $serviceLocator, $config, $objectManager)
+    {
+        $createFilterManager = $serviceLocator->get('ZfApigilityDoctrineQueryCreateFilterManager');
+        $filterManagerAlias = (isset($config['query_create_filter'])) ? $config['query_create_filter']: 'default';
+
+        return $createFilterManager->get($filterManagerAlias);
+    }
+
+
     /**
      * @param ServiceLocatorInterface $serviceLocator
      * @param                         $config