Merge pull request #9 from symfony-cmf/sonata_admin

SonataAdminEnhancer

Author: wouterj

.travis.yml

@@ -41,8 +41,8 @@ before_script:
 
 script:
     - phpunit --coverage-text
-    - ./vendor/symfony-cmf/testing/bin/server &
-    - ./vendor/bin/behat
+    - if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then ./vendor/symfony-cmf/testing/bin/server & fi
+    - if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then ./vendor/bin/behat; fi
 
 notifications:
   irc: "irc.freenode.org#symfony-cmf"

CmfResourceRestBundle.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

Controller/ResourceController.php

@@ -4,7 +4,6 @@
 
 use Symfony\Cmf\Component\Resource\RepositoryRegistryInterface;
 use Symfony\Component\HttpFoundation\Response;
-use Hateoas\UrlGenerator\UrlGeneratorInterface;
 use JMS\Serializer\SerializerInterface;
 use JMS\Serializer\SerializationContext;
 
@@ -15,11 +14,6 @@ class ResourceController
      */
     private $registry;
 
-    /**
-     * @var UrlGeneratorInterface
-     */
-    private $urlGenerator;
-
     /**
      * @var SerializerInterface
      */
@@ -30,23 +24,24 @@ class ResourceController
      */
     public function __construct(
         SerializerInterface $serializer,
-        RepositoryRegistryInterface $registry,
-        UrlGeneratorInterface $urlGenerator
+        RepositoryRegistryInterface $registry
     ) {
         $this->serializer = $serializer;
         $this->registry = $registry;
-        $this->urlGenerator = $urlGenerator;
     }
 
     public function resourceAction($repositoryName, $path)
     {
         $repository = $this->registry->get($repositoryName);
         $resource = $repository->get('/' . $path);
 
+        $context = SerializationContext::create();
+        $context->enableMaxDepthChecks();
+        $context->setSerializeNull(true);
         $json = $this->serializer->serialize(
             $resource,
             'json',
-            SerializationContext::create()->enableMaxDepthChecks()
+            $context
         );
 
         return new Response($json);

DependencyInjection/CmfResourceRestExtension.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,32 +15,15 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
-use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\Config\Definition\Processor;
+use Symfony\Component\Config\Loader\LoaderInterface;
 
-class CmfResourceRestExtension extends Extension implements PrependExtensionInterface
+class CmfResourceRestExtension extends Extension
 {
-    public function prepend(ContainerBuilder $container)
-    {
-        $container->prependExtensionConfig('jms_serializer', array(
-            'metadata' => array(
-                'directories' => array(
-                    array(
-                        'path' => __DIR__ . '/../Resources/config/serializer',
-                        'namespace_prefix' => 'Symfony\Cmf\Component\Resource\Repository\Resource',
-                    ),
-                    array(
-                        'path' => __DIR__ . '/../Resources/config/serializer',
-                        'namespace_prefix' => 'Puli\Repository\Resource',
-                    ),
-                    array(
-                        'path' => __DIR__ . '/../Resources/config/serializer',
-                        'namespace_prefix' => 'PHPCR',
-                    ),
-                ),
-            ),
-        ));
-    }
+    private $nativeEnhancers = array(
+        'payload',
+        'sonata_admin',
+    );
 
     /**
      * {@inheritDoc}
@@ -54,24 +37,56 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('serializer.xml');
         $loader->load('resource-rest.xml');
-        $loader->load('enhancer.xml');
 
+        $this->loadEnhancers($container, $loader, $config['enhancer_map']);
         $this->configurePayloadAliasRegistry($container, $config['payload_alias_map']);
-        $this->configureEnhancerMap($container, $config['enhancer_map']);
+        $this->configureEnhancers($container, $config['enhancer_map']);
     }
 
     public function getNamespace()
     {
         return 'http://cmf.symfony.com/schema/dic/' . $this->getAlias();
     }
 
+    /**
+     * Automatically include native enhancers
+     */
+    private function loadEnhancers(ContainerBuilder $container, LoaderInterface $loader, $enhancerMap)
+    {
+        $loaded = array();
+        foreach ($enhancerMap as $unit) {
+            $enhancerName = $unit['enhancer'];
+
+            if (!in_array($enhancerName, $this->nativeEnhancers)) {
+                continue;
+            }
+
+            if (isset($loaded[$enhancerName])) {
+                continue;
+            }
+
+            $loader->load('enhancer.' . $enhancerName . '.xml');
+            $loaded[$enhancerName] = true;
+        }
+
+        $bundles = $container->getParameter('kernel.bundles');
+
+        if (isset($loaded['sonata_admin'])) {
+            if (!isset($bundles['SonataAdminBundle'])) {
+                throw new \InvalidArgumentException(
+                    'You must enable the SonataAdminBundle in order to use the "sonata_admin" enhancer'
+                );
+            }
+        }
+    }
+
     private function configurePayloadAliasRegistry(ContainerBuilder $container, $aliasMap)
     {
         $registry = $container->getDefinition('cmf_resource_rest.registry.payload_alias');
         $registry->replaceArgument(1, $aliasMap);
     }
 
-    private function configureEnhancerMap(ContainerBuilder $container, $enhancerMap)
+    private function configureEnhancers(ContainerBuilder $container, $enhancerMap)
     {
         $enhancerMap = $this->normalizeEnhancerMap($enhancerMap);
         $registry = $container->getDefinition('cmf_resource_rest.registry.enhancer');

DependencyInjection/Compiler/EnhancerPass.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -13,7 +13,6 @@
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 
 /**

DependencyInjection/Configuration.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

Enhancer/EnhancerInterface.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -31,5 +31,5 @@ interface EnhancerInterface
      * @param Context Serialization context
      * @param Resource The resource being serialized
      */
-    public function enhance(Context $context, Resource $resource);
+    public function enhance(array $data, Resource $resource);
 }

Enhancer/PayloadEnhancer.php

@@ -3,15 +3,14 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2014 Symfony CMF
+ * (c) 2011-2015 Symfony CMF
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
 namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
 
-use JMS\Serializer\Context;
 use Puli\Repository\Api\Resource\Resource;
 
 /**
@@ -24,9 +23,11 @@ class PayloadEnhancer implements EnhancerInterface
     /**
      * {@inheritDoc}
      */
-    public function enhance(Context $context, Resource $resource)
+    public function enhance(array $data, Resource $resource)
     {
-        $visitor = $context->getVisitor();
-        $visitor->addData('payload', $context->accept($resource->getPayload()));
+        $payload = $resource->getPayload();
+        $data['payload'] = $payload;
+
+        return $data;
     }
 }

Enhancer/SonataAdminEnhancer.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
+
+use Puli\Repository\Api\Resource\Resource;
+use Sonata\AdminBundle\Admin\Pool;
+use Doctrine\Common\Util\ClassUtils;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+/**
+ * Add links and meta-info from Sonata Admin
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class SonataAdminEnhancer implements EnhancerInterface
+{
+    /**
+     * @var Pool
+     */
+    private $pool;
+
+    /**
+     * @var UrlGeneratorInterface
+     */
+    private $urlGenerator;
+
+    /**
+     * __construct
+     *
+     * @param Pool $pool
+     * @param UrlGeneratorInterface $urlGenerator
+     */
+    public function __construct(Pool $pool, UrlGeneratorInterface $urlGenerator)
+    {
+        $this->pool = $pool;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function enhance(array $data, Resource $resource)
+    {
+        $object = $resource->getPayload();
+
+        // sonata has dependency on ClassUtils so this is fine.
+        $class = ClassUtils::getClass($object);
+
+        if (false === $this->pool->hasAdminByClass($class)) {
+            return $data;
+        }
+
+        $admin = $this->pool->getAdminByClass($class);
+
+        $links = array();
+
+        $routeCollection = $admin->getRoutes();
+
+        foreach ($routeCollection->getElements() as $code => $route) {
+            $routeName = $route->getDefault('_sonata_name');
+            $url = $this->urlGenerator->generate($routeName, array(
+                $admin->getIdParameter() => $admin->getUrlsafeIdentifier($object),
+            ), true);
+
+            $routeRole = substr($code, strlen($admin->getCode()) + 1);
+
+            $links[$routeRole] = $url;
+        }
+
+        $data['sonata_label'] = $admin->getLabel();
+        $data['sonata_links'] = $links;
+
+        return $data;
+    }
+}