Event support. FOSUser bridge. Updated readme.

Author: dunglas

ApiDocumentationBuilder.php

@@ -48,11 +48,11 @@ class ApiDocumentationBuilder
     private $description;
 
     /**
-     * @param Resources $resources
-     * @param RouterInterface $router
+     * @param Resources            $resources
+     * @param RouterInterface      $router
      * @param ClassMetadataFactory $classMetadataFactory
-     * @param string $title
-     * @param string $description
+     * @param string               $title
+     * @param string               $description
      */
     public function __construct(
         Resources $resources,
@@ -96,7 +96,7 @@ public function getApiDocumentation()
             foreach ($resource->getCollectionOperations() as $operation) {
                 $supportedOperation = [];
 
-                if('POST' === $operation['hydra:method']) {
+                if ('POST' === $operation['hydra:method']) {
                     $supportedOperation['@type'] = 'hydra:CreateResourceOperation';
                     $supportedOperation['hydra:title'] = sprintf('Creates a %s resource.', $shortName);
                     $supportedOperation['hydra:expects'] = $shortName;

Controller/ResourceController.php

@@ -12,6 +12,8 @@
 namespace Dunglas\JsonLdApiBundle\Controller;
 
 use Doctrine\ORM\Tools\Pagination\Paginator;
+use Dunglas\JsonLdApiBundle\DunglasJsonLdApiEvents;
+use Dunglas\JsonLdApiBundle\Event\ObjectEvent;
 use Dunglas\JsonLdApiBundle\Resource;
 use Dunglas\JsonLdApiBundle\Response\JsonLdResponse;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
@@ -167,10 +169,7 @@ public function postAction(Request $request)
         $violations = $this->get('validator')->validate($object, null, $resource->getValidationGroups());
         if (0 === count($violations)) {
             // Validation succeed
-            $manager = $this->getManager($resource);
-
-            $manager->persist($object);
-            $manager->flush();
+            $this->get('event_dispatcher')->dispatch(DunglasJsonLdApiEvents::PRE_CREATE, new ObjectEvent($resource, $object));
 
             return new JsonLdResponse($this->normalize($resource, $object), 201);
         }
@@ -226,7 +225,7 @@ public function putAction(Request $request, $id)
         $violations = $this->get('validator')->validate($object, null, $resource->getValidationGroups());
         if (0 === count($violations)) {
             // Validation succeed
-            $this->getManager($resource)->flush();
+            $this->get('event_dispatcher')->dispatch(DunglasJsonLdApiEvents::PRE_UPDATE, new ObjectEvent($resource, $object));
 
             return new JsonLdResponse($this->normalize($resource, $object), 202);
         }
@@ -250,9 +249,7 @@ public function deleteAction(Request $request, $id)
         $resource = $this->getResource($request);
         $object = $this->findOrThrowNotFound($resource, $id);
 
-        $manager = $this->getManager($resource);
-        $manager->remove($object);
-        $manager->flush();
+        $this->get('event_dispatcher')->dispatch(DunglasJsonLdApiEvents::PRE_DELETE, new ObjectEvent($resource, $object));
 
         return new JsonLdResponse(null, 204);
     }

DependencyInjection/Configuration.php

@@ -34,6 +34,7 @@ public function getConfigTreeBuilder()
                 ->scalarNode('title')->cannotBeEmpty()->isRequired()->info('API\'s title.')->end()
                 ->scalarNode('description')->cannotBeEmpty()->isRequired()->info('API\'s description.')->end()
                 ->integerNode('elements_by_page')->min(1)->defaultValue(100)->cannotBeEmpty()->info('The number of elements by page in collections.')->end()
+                ->booleanNode('enable_fos_user_event_subscriber')->defaultFalse()->end()
             ->end()
         ;
 

DependencyInjection/DunglasJsonLdApiExtension.php

@@ -13,17 +13,29 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
-
 /**
  * The extension of this bundle.
  *
  * @author Kévin Dunglas <[email protected]>
  */
-class DunglasJsonLdApiExtension extends Extension
+class DunglasJsonLdApiExtension extends Extension implements PrependExtensionInterface
 {
+    /**
+     * {@inheritdoc}
+     */
+    public function prepend(ContainerBuilder $container)
+    {
+        if (isset($container->getParameter('kernel.bundles')['FOSUserBundle'])) {
+            $container->prependExtensionConfig($this->getAlias(), ['enable_fos_user_event_subscriber' => true]);
+        }
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -38,5 +50,15 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
+
+        if ($config['enable_fos_user_event_subscriber']) {
+            $definition = new Definition(
+                'Dunglas\JsonLdApiBundle\EventListener\FOSUserEventSubscriber',
+                [new Reference('fos_user.user_manager')]
+            );
+            $definition->setTags(['kernel.event_subscriber' => []]);
+
+            $container->setDefinition('dunglas_json_ld_api.event_subscriber.fos_user', $definition);
+        }
     }
 }

DunglasJsonLdApiEvents.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the DunglasJsonLdApiBundle package.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dunglas\JsonLdApiBundle;
+
+/**
+ * API Events.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+final class DunglasJsonLdApiEvents
+{
+    /**
+     * The PRE_CREATE event occurs after the object validation and before its persistence during POST request.
+     *
+     * @var string
+     */
+    const PRE_CREATE = 'dunglas_json_ld_api.pre_create';
+    /**
+     * The PRE_UPDATE event occurs after the object validation and before its persistence during a PUT request.
+     *
+     * @var string
+     */
+    const PRE_UPDATE = 'dunglas_json_ld_api.pre_update';
+    /**
+     * The PRE_DELETE event occurs before the object deletion.
+     */
+    const PRE_DELETE = 'dunglas_json_ld_api.pre_delete';
+}

Event/ObjectEvent.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the DunglasJsonLdApiBundle package.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dunglas\JsonLdApiBundle\Event;
+
+use Dunglas\JsonLdApiBundle\Resource;
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * ObjectEvent.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class ObjectEvent extends Event
+{
+    /**
+     * @var Resource
+     */
+    private $resource;
+    /**
+     * @var object
+     */
+    private $object;
+
+    /**
+     * @param object $object
+     */
+    public function __construct(Resource $resource, $object)
+    {
+        $this->resource = $resource;
+        $this->object = $object;
+    }
+
+    /**
+     * Gets related resource.
+     *
+     * @return Resource
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+
+    /**
+     * Gets related object.
+     *
+     * @return object
+     */
+    public function getObject()
+    {
+        return $this->object;
+    }
+}

EventListener/DoctrineEventSubscriber.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the DunglasJsonLdApiBundle package.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dunglas\JsonLdApiBundle\EventListener;
+
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Dunglas\JsonLdApiBundle\DunglasJsonLdApiEvents;
+use Dunglas\JsonLdApiBundle\Event\ObjectEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Doctrine Event Listener.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class DoctrineEventSubscriber implements EventSubscriberInterface
+{
+    /**
+     * @var ManagerRegistry
+     */
+    private $managerRegistry;
+
+    public function __construct(ManagerRegistry $managerRegistry)
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            DunglasJsonLdApiEvents::PRE_CREATE => ['persistObject', 0],
+            DunglasJsonLdApiEvents::PRE_UPDATE => ['persistObject', 0],
+            DunglasJsonLdApiEvents::PRE_DELETE => ['deleteObject', 0],
+        ];
+    }
+
+    /**
+     * Persists the given object and flushes.
+     *
+     * @param ObjectEvent $event
+     */
+    public function persistObject(ObjectEvent $event)
+    {
+        $objectManager = $this->managerRegistry->getManagerForClass($event->getResource()->getEntityClass());
+
+        $objectManager->persist($event->getObject());
+        $objectManager->flush();
+    }
+
+    /**
+     * Removes the given object and flushes.
+     *
+     * @param ObjectEvent $event
+     */
+    public function deleteObject(ObjectEvent $event)
+    {
+        $objectManager = $this->managerRegistry->getManagerForClass($event->getResource()->getEntityClass());
+
+        $objectManager->remove($event->getObject());
+        $objectManager->flush();
+    }
+}

EventListener/FOSUserEventSubscriber.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the DunglasJsonLdApiBundle package.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dunglas\JsonLdApiBundle\EventListener;
+
+use Dunglas\JsonLdApiBundle\DunglasJsonLdApiEvents;
+use Dunglas\JsonLdApiBundle\Event\ObjectEvent;
+use FOS\UserBundle\Model\UserManagerInterface;
+use FOS\UserBundle\Model\UserInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Bridges between FOSUserBundle and DunglasJsonLdApiBundle.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class FOSUserEventSubscriber implements EventSubscriberInterface
+{
+    /**
+     * @var UserManagerInterface
+     */
+    private $userManager;
+
+    public function __construct(UserManagerInterface $userManager)
+    {
+        $this->userManager = $userManager;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            DunglasJsonLdApiEvents::PRE_CREATE => ['persistObject', 1],
+            DunglasJsonLdApiEvents::PRE_UPDATE => ['persistObject', 1],
+            DunglasJsonLdApiEvents::PRE_DELETE => ['deleteObject', 1],
+        ];
+    }
+
+    /**
+     * Persists the given user object.
+     *
+     * @param ObjectEvent $event
+     */
+    public function persistObject(ObjectEvent $event)
+    {
+        $object = $event->getObject();
+        if ($object instanceof UserInterface) {
+            $this->userManager->updateUser($object);
+            $event->stopPropagation();
+        }
+    }
+
+    /**
+     * Removes the given user object.
+     *
+     * @param ObjectEvent $event
+     */
+    public function deleteObject(ObjectEvent $event)
+    {
+        $object = $event->getObject();
+        if ($object instanceof UserInterface) {
+            $this->userManager->deleteUser($event->getObject());
+            $event->stopPropagation();
+        }
+    }
+}

Mapping/ClassMetadata.php

@@ -309,6 +309,7 @@ private function populateAttribute($name, array &$attribute, array $validationGr
 
             if ($reflClass->hasProperty($name)) {
                 $attribute['description'] = (new DocBlock($reflClass->getProperty($name)))->getShortDescription();
+
                 return;
             }
 
@@ -324,6 +325,7 @@ private function populateAttribute($name, array &$attribute, array $validationGr
 
             if ($method) {
                 $attribute['description'] = (new DocBlock($reflClass->getMethod($method)))->getShortDescription();
+
                 return;
             }