[WIP] Refactor event system

DependencyInjection/Configuration.php

@@ -28,6 +28,9 @@ public function getConfigTreeBuilder()
                 ->scalarNode('storage')->defaultValue('vich_uploader.storage.file_system')->end()
                 ->scalarNode('twig')->defaultTrue()->end()
                 ->scalarNode('gaufrette')->defaultFalse()->end()
+                ->scalarNode('upload_on_persist')->defaultTrue()->end()
+                ->scalarNode('unlink_on_remove')->defaultTrue()->end()
+                ->scalarNode('inject_on_load')->defaultTrue()->end()
                 ->arrayNode('mappings')
                     ->useAttributeAsKey('id')
                     ->prototype('array')

DependencyInjection/VichUploaderExtension.php

@@ -9,6 +9,9 @@
 use Vich\UploaderBundle\DependencyInjection\Configuration;
 use Symfony\Component\HttpKernel\Kernel;
 
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\DefinitionDecorator;
+
 /**
  * VichUploaderExtension.
  *
@@ -84,4 +87,32 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('vich_uploader.adapter.class', $this->adapterMap[$driver]);
         $container->getDefinition('vich_uploader.listener.uploader')->addTag($this->tagMap[$driver]);
     }
+
+    private function loadEventListeners(array $config, ContainerBuilder $container)
+    {
+        if ($config['inject_on_load']) {
+            $container
+                ->setDefinition('vich_uploader.listener.inject', new DefinitionDecorator('vich_uploader.event_listener.abstract'))
+                ->setClass('vich_uploader.listener.inject.class')
+                ->setPublic(false)
+                ->addTag('doctrine.event_listener', array('event' => 'postLoad'));
+        }
+
+        if ($config['upload_on_persist']) {
+            $container
+                ->setDefinition('vich_uploader.listener.upload', new DefinitionDecorator('vich_uploader.event_listener.abstract'))
+                ->setClass('vich_uploader.listener.upload.class')
+                ->setPublic(false)
+                ->addTag('doctrine.event_listener', array('event' => 'prePersist'))
+                ->addTag('doctrine.event_listener', array('event' => 'preUpdate'));
+        }
+
+        if ($config['unlink_on_remove']) {
+            $container
+                ->setDefinition('vich_uploader.listener.inject', new DefinitionDecorator('vich_uploader.event_listener.abstract'))
+                ->setClass('vich_uploader.listener.inject.class')
+                ->setPublic(false)
+                ->addTag('doctrine.event_listener', array('event' => 'postRemove'));
+        }        
+    }
 }

EventListener/AbstractListener.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Vich\UploaderBundle\EventListener;
+
+use Vich\UploaderBundle\Storage\StorageInterface;
+use Vich\UploaderBundle\Adapter\AdapterInterface;
+use Vich\UploaderBundle\Injector\FileInjectorInterface;
+use Vich\UploaderBundle\Driver\AnnotationDriver;
+
+abstract class AbstractListener
+{
+    /**
+     * @var AdapterInterface
+     */
+    protected $adapter;
+
+    /**
+     * @var AnnotationDriver
+     */
+    protected $driver;
+
+    /**
+     * @var StorageInterface
+     */
+    protected $storage;
+
+    /**
+     * @var FileInjectorInterface
+     */
+    protected $injector;
+
+    /**
+     * Constructs a new instance of UploaderListener.
+     *
+     * @param AdapterInterface      $adapter  The adapter.
+     * @param AnnotationDriver      $driver   The driver.
+     * @param StorageInterface      $storage  The storage.
+     * @param FileInjectorInterface $injector The injector.
+     */
+    public function __construct(AdapterInterface $adapter, AnnotationDriver $driver, StorageInterface $storage, FileInjectorInterface $injector)
+    {
+        $this->adapter = $adapter;
+        $this->driver = $driver;
+        $this->storage = $storage;
+        $this->injector = $injector;
+    }
+
+    /**
+     * Tests if the object is Uploadable.
+     *
+     * @param  object  $obj The object.
+     * @return boolean True if uploadable, false otherwise.
+     */
+    protected function isUploadable($obj)
+    {
+        $class = $this->adapter->getReflectionClass($obj);
+
+        return null !== $this->driver->readUploadable($class);
+    }    
+}

EventListener/InjectListener.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Vich\UploaderBundle\EventListener;
+
+use Doctrine\Common\EventArgs;
+
+class InjectListener extends AbstractListener
+{
+    /**
+     * Populates uploadable fields from filename properties
+     * if necessary.
+     *
+     * @param \Doctrine\Common\EventArgs $args
+     */
+    public function postLoad(EventArgs $args)
+    {
+        $obj = $this->adapter->getObjectFromArgs($args);
+        if ($this->isUploadable($obj)) {
+            $this->injector->injectFiles($obj);
+        }
+    }}

EventListener/UnlinkListener.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Vich\UploaderBundle\EventListener;
+
+use Doctrine\Common\EventArgs;
+
+class UnlinkListener extends AbstractListener
+{
+    /**
+     * Removes the file if necessary.
+     *
+     * @param EventArgs $args The event arguments.
+     */    
+    public function postRemove(EventArgs $args)
+    {
+        $obj = $this->adapter->getObjectFromArgs($args);
+        if ($this->isUploadable($obj)) {
+            $this->storage->remove($obj);
+        }
+    }
+}

EventListener/UploadListener.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Vich\UploaderBundle\EventListener;
+
+use Doctrine\Common\EventArgs;
+
+class UploadListener extends AbstractListener
+{
+    /**
+     * Checks for for file to upload.
+     *
+     * @param \Doctrine\Common\EventArgs $args The event arguments.
+     */
+    public function prePersist(EventArgs $args)
+    {
+        $obj = $this->adapter->getObjectFromArgs($args);
+        if ($this->isUploadable($obj)) {
+            $this->storage->upload($obj);
+        }
+    }
+
+    /**
+     * Update the file and file name if necessary.
+     *
+     * @param EventArgs $args The event arguments.
+     */
+    public function preUpdate(EventArgs $args)
+    {
+        $obj = $this->adapter->getObjectFromArgs($args);
+        if ($this->isUploadable($obj)) {
+            $this->storage->upload($obj);
+
+            $this->adapter->recomputeChangeSet($args);
+        }
+    }
+}

Resources/config/listener.xml

@@ -4,9 +4,15 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
-    <services>
+    <parameters>
+        <parameter key="vich_uploader.listener.abstract.class">Vich\UploaderBundle\EventListener\AbstractListener</parameter>
+        <parameter key="vich_uploader.listener.inject.class">Vich\UploaderBundle\EventListener\InjectListener</parameter>
+        <parameter key="vich_uploader.listener.upload.class">Vich\UploaderBundle\EventListener\UploadListener</parameter>
+        <parameter key="vich_uploader.listener.unlink.class">Vich\UploaderBundle\EventListener\UnlinkListener</parameter>
+    </parameters>
 
-        <service id="vich_uploader.listener.uploader" class="Vich\UploaderBundle\EventListener\UploaderListener" public="false">
+    <services>
+        <service id="vich_uploader.listener.abstract" class="%vich_uploader.listener.abstract.class%" abstract="true">
             <argument type="service" id="vich_uploader.adapter" />
             <argument type="service" id="vich_uploader.annotation_driver" />
             <argument type="service" id="vich_uploader.storage" />