[WIP] Propel integration

Adapter/AdapterInterface.php

@@ -2,8 +2,6 @@
 
 namespace Vich\UploaderBundle\Adapter;
 
-use Doctrine\Common\EventArgs;
-
 /**
  * AdapterInterface.
  *
@@ -12,26 +10,26 @@
 interface AdapterInterface
 {
     /**
-     * Gets the mapped object from the event arguments.
+     * Gets the mapped object from an event.
      *
-     * @param  EventArgs $e The event arguments.
-     * @return object    The mapped object.
+     * @param  object $event The event argument.
+     * @return object The mapped object.
      */
-    public function getObjectFromArgs(EventArgs $e);
+    public function getObjectFromEvent($event);
 
     /**
-     * Recomputes the change set for the object.
+     * Recomputes the change set for the given object.
      *
-     * @param EventArgs $e The event arguments.
+     * @param object $event The event arguments.
      */
-    public function recomputeChangeSet(EventArgs $e);
+    public function recomputeChangeSet($event);
 
     /**
-     * Gets the reflection class for the object taking
-     * proxies into account.
+     * Gets class name for the object, taking proxies into account.
+     *
+     * @param object $object The object.
      *
-     * @param  object           $obj The object.
-     * @return \ReflectionClass The reflection class.
+     * @return string The FQCN of the className.
      */
-    public function getReflectionClass($obj);
+    public function getClassName($object);
 }

Adapter/ODM/MongoDB/MongoDBAdapter.php

@@ -3,7 +3,6 @@
 namespace Vich\UploaderBundle\Adapter\ODM\MongoDB;
 
 use Vich\UploaderBundle\Adapter\AdapterInterface;
-use Doctrine\Common\EventArgs;
 use Doctrine\ODM\MongoDB\Proxy\Proxy;
 
 /**
@@ -16,33 +15,36 @@ class MongoDBAdapter implements AdapterInterface
     /**
      * {@inheritDoc}
      */
-    public function getObjectFromArgs(EventArgs $e)
+    public function getObjectFromEvent($event)
     {
-        return $e->getDocument();
+        /* @var $event \Doctrine\Common\EventArgs */
+
+        return $event->getDocument();
     }
 
     /**
      * {@inheritDoc}
      */
-    public function recomputeChangeSet(EventArgs $e)
+    public function recomputeChangeSet($event)
     {
-        $obj = $this->getObjectFromArgs($e);
+        /* @var $event \Doctrine\Common\EventArgs */
+        $object = $this->getObjectFromEvent($event);
 
-        $dm = $e->getDocumentManager();
+        $dm = $event->getDocumentManager();
         $uow = $dm->getUnitOfWork();
-        $metadata = $dm->getClassMetadata(get_class($obj));
-        $uow->recomputeSingleDocumentChangeSet($metadata, $obj);
+        $metadata = $dm->getClassMetadata(get_class($object));
+        $uow->recomputeSingleDocumentChangeSet($metadata, $object);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getReflectionClass($obj)
+    public function getClassName($object)
     {
-        if ($obj instanceof Proxy) {
-            return new \ReflectionClass(get_parent_class($obj));
+        if ($object instanceof Proxy) {
+            return get_parent_class($object);
+        } else {
+            return get_class($object);
         }
-
-        return new \ReflectionClass($obj);
     }
 }

Adapter/ORM/DoctrineORMAdapter.php

@@ -3,7 +3,6 @@
 namespace Vich\UploaderBundle\Adapter\ORM;
 
 use Vich\UploaderBundle\Adapter\AdapterInterface;
-use Doctrine\Common\EventArgs;
 use Doctrine\Common\Persistence\Proxy;
 
 /**
@@ -16,33 +15,36 @@ class DoctrineORMAdapter implements AdapterInterface
     /**
      * {@inheritDoc}
      */
-    public function getObjectFromArgs(EventArgs $e)
+    public function getObjectFromEvent($event)
     {
-        return $e->getEntity();
+        /* @var $event \Doctrine\Common\EventArgs */
+
+        return $event->getEntity();
     }
 
     /**
      * {@inheritDoc}
      */
-    public function recomputeChangeSet(EventArgs $e)
+    public function recomputeChangeSet($event)
     {
-        $obj = $this->getObjectFromArgs($e);
+        /* @var $event \Doctrine\Common\EventArgs */
+        $object = $this->getObjectFromEvent($event);
 
-        $em = $e->getEntityManager();
+        $em = $event->getEntityManager();
         $uow = $em->getUnitOfWork();
-        $metadata = $em->getClassMetadata(get_class($obj));
-        $uow->recomputeSingleEntityChangeSet($metadata, $obj);
+        $metadata = $em->getClassMetadata(get_class($object));
+        $uow->recomputeSingleEntityChangeSet($metadata, $object);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getReflectionClass($obj)
+    public function getClassName($object)
     {
-        if ($obj instanceof Proxy) {
-            return new \ReflectionClass(get_parent_class($obj));
+        if ($object instanceof Proxy) {
+            return get_parent_class($object);
+        } else {
+            return get_class($object);
         }
-
-        return new \ReflectionClass($obj);
     }
 }

Adapter/Propel/PropelAdapter.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Vich\UploaderBundle\Adapter\Propel;
+
+use Vich\UploaderBundle\Adapter\AdapterInterface;
+
+/**
+ * Propel adapter.
+ *
+ * @author Kévin Gomez <[email protected]>
+ */
+class PropelAdapter implements AdapterInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getObjectFromEvent($event)
+    {
+        /* @var $event \Symfony\Component\EventDispatcher\GenericEvent */
+
+        return $event->getSubject();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function recomputeChangeSet($event)
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getClassName($object)
+    {
+        return get_class($object);
+    }
+}

DependencyInjection/CompilerPass/RegisterPropelModelsPass.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Vich\UploaderBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Register the uploadable models in BazingaPropelEventDispatcherBundle
+ *
+ * @author Kévin Gomez <[email protected]>
+ */
+class RegisterPropelModelsPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->getParameter('vich_uploader.driver') !== 'propel') {
+            return;
+        }
+
+        $propelListener = $container->getDefinition('vich_uploader.listener.uploader.propel');
+        $metadata = $container->get('vich_uploader.metadata_reader');
+        foreach ($metadata->getUploadableClasses() as $class) {
+            $propelListener->addTag('propel.event_subscriber', array(
+                'class' => $class
+            ));
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -2,6 +2,7 @@
 
 namespace Vich\UploaderBundle\DependencyInjection;
 
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
@@ -22,12 +23,37 @@ public function getConfigTreeBuilder()
         $tb = new TreeBuilder();
         $root = $tb->root('vich_uploader');
 
+        $supportedDbDrivers = array('orm', 'odm', 'propel');
+
         $root
             ->children()
-                ->scalarNode('db_driver')->isRequired()->end()
+                ->scalarNode('db_driver')
+                    ->isRequired()
+                    ->beforeNormalization()
+                        ->ifString()
+                        ->then(function ($v) { return strtolower($v); })
+                    ->end()
+                    ->validate()
+                        ->ifNotInArray($supportedDbDrivers)
+                        ->thenInvalid('The db driver %s is not supported. Please choose one of ' . implode(', ', $supportedDbDrivers))
+                    ->end()
+                ->end()
                 ->scalarNode('storage')->defaultValue('vich_uploader.storage.file_system')->end()
                 ->scalarNode('twig')->defaultTrue()->end()
                 ->scalarNode('gaufrette')->defaultFalse()->end()
+            ->end()
+        ;
+
+        $this->addMetadataSection($root);
+        $this->addMappingsSection($root);
+
+        return $tb;
+    }
+
+    protected function addMetadataSection(ArrayNodeDefinition $node)
+    {
+        $node
+            ->children()
                 ->arrayNode('metadata')
                     ->addDefaultsIfNotSet()
                     ->fixXmlConfig('directory', 'directories')
@@ -50,6 +76,13 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
+            ->end();
+    }
+
+    protected function addMappingsSection(ArrayNodeDefinition $node)
+    {
+        $node
+            ->children()
                 ->arrayNode('mappings')
                     ->useAttributeAsKey('id')
                     ->prototype('array')
@@ -64,9 +97,6 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
-            ->end()
-        ;
-
-        return $tb;
+            ->end();
     }
 }