[POC] Metadata and Annotation support

DependencyInjection/CmfRoutingExtension.php

@@ -34,10 +34,12 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $config = $this->processConfiguration(new Configuration(), $configs);
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('metadata.xml');
 
         if ($config['dynamic']['enabled']) {
             // load this even if no explicit enabled value but some configuration
             $this->setupDynamicRouter($config['dynamic'], $container, $loader);
+            $this->setupMetadataDrivers($config['dynamic'], $container);
         }
 
         /* set up the chain router */
@@ -53,6 +55,52 @@ public function load(array $configs, ContainerBuilder $container)
         $this->setupFormTypes($config, $container, $loader);
     }
 
+    public function setupMetadataDrivers($config, ContainerBuilder $container)
+    {
+        $configDriver = $container->getDefinition($this->getAlias() . '.metadata.driver.configuration');
+        $annotationDriver = $container->getDefinition($this->getAlias() . '.metadata.driver.annotation');
+
+        $mapping = array();
+
+        $controller = $container->getParameter($this->getAlias() . '.generic_controller');;
+
+        // configure annotation driver
+        $annotationDriver->addMethodCall('setGenericController', array($controller));
+
+        $mappings = array();
+
+        // configure configuration driver
+        if (!empty($config['controllers_by_class'])) {
+            foreach ($config['controllers_by_class'] as $classFqn => $controller) {
+                if (!isset($mappings[$classFqn])) {
+                    $mappings[$classFqn] = array();
+                }
+
+                $mappings[$classFqn]['controller'] = $controller;
+            }
+        }
+
+        if (!empty($config['templates_by_class'])) {
+            foreach ($config['templates_by_class'] as $classFqn => $template) {
+                if (!isset($mappings[$classFqn])) {
+                    $mappings[$classFqn] = array();
+                }
+
+                $mappings[$classFqn]['template'] = $template;
+            }
+        }
+
+        foreach ($mappings as $classFqn => &$mapping) {
+            if (!isset($mapping['controller'])) {
+                $mapping['controller'] = $container->getParameter(
+                    $this->getAlias() . '.generic_controller'
+                );
+            }
+
+            $configDriver->addMethodCall('registerMapping', array($classFqn, $mapping));
+        }
+    }
+
     public function setupFormTypes(array $config, ContainerBuilder $container, LoaderInterface $loader)
     {
         $loader->load('form-type.xml');
@@ -76,7 +124,7 @@ public function setupFormTypes(array $config, ContainerBuilder $container, Loade
     private function setupDynamicRouter(array $config, ContainerBuilder $container, LoaderInterface $loader)
     {
         // strip whitespace (XML support)
-        foreach (array('controllers_by_type', 'controllers_by_class', 'templates_by_class', 'route_filters_by_id') as $option) {
+        foreach (array('controllers_by_type', 'route_filters_by_id') as $option) {
             $config[$option] = array_map(function ($value) {
                 return trim($value);
             }, $config[$option]);
@@ -86,11 +134,10 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         if (null === $defaultController) {
             $defaultController = $config['generic_controller'];
         }
+
         $container->setParameter($this->getAlias() . '.default_controller', $defaultController);
         $container->setParameter($this->getAlias() . '.generic_controller', $config['generic_controller']);
         $container->setParameter($this->getAlias() . '.controllers_by_type', $config['controllers_by_type']);
-        $container->setParameter($this->getAlias() . '.controllers_by_class', $config['controllers_by_class']);
-        $container->setParameter($this->getAlias() . '.templates_by_class', $config['templates_by_class']);
         $container->setParameter($this->getAlias() . '.uri_filter_regexp', $config['uri_filter_regexp']);
         $container->setParameter($this->getAlias() . '.route_collection_limit', $config['route_collection_limit']);
 
@@ -150,55 +197,23 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
                 )
             );
         }
-        if (!empty($config['controllers_by_class'])) {
-            $dynamic->addMethodCall(
-                'addRouteEnhancer',
-                array(
-                    new Reference($this->getAlias() . '.enhancer.controllers_by_class'),
-                    50
-                )
-            );
-        }
-        if (!empty($config['templates_by_class'])) {
-            $dynamic->addMethodCall(
-                'addRouteEnhancer',
-                array(
-                    new Reference($this->getAlias() . '.enhancer.templates_by_class'),
-                    40
-                )
-            );
 
-            /*
-             * The CoreBundle prepends the controller from ContentBundle if the
-             * ContentBundle is present in the project.
-             * If you are sure you do not need a generic controller, set the field
-             * to false to disable this check explicitly. But you would need
-             * something else like the default_controller to set the controller,
-             * as no controller will be set here.
-             */
-            if (null === $config['generic_controller']) {
-                throw new InvalidConfigurationException('If you want to configure templates_by_class, you need to configure the generic_controller option.');
-            }
+        $dynamic->addMethodCall(
+            'addRouteEnhancer',
+            array(
+                new Reference($this->getAlias() . '.enhancer.controllers_by_class'),
+                50
+            )
+        );
+
+        $dynamic->addMethodCall(
+            'addRouteEnhancer',
+            array(
+                new Reference($this->getAlias() . '.enhancer.templates_by_class'),
+                40
+            )
+        );
 
-            if (is_string($config['generic_controller'])) {
-                // if the content class defines the template, we also need to make sure we use the generic controller for those routes
-                $controllerForTemplates = array();
-                foreach ($config['templates_by_class'] as $key => $value) {
-                    $controllerForTemplates[$key] = $config['generic_controller'];
-                }
-
-                $definition = $container->getDefinition($this->getAlias() . '.enhancer.controller_for_templates_by_class');
-                $definition->replaceArgument(2, $controllerForTemplates);
-
-                $dynamic->addMethodCall(
-                    'addRouteEnhancer',
-                    array(
-                        new Reference($this->getAlias() . '.enhancer.controller_for_templates_by_class'),
-                        30
-                    )
-                );
-            }
-        }
         if (!empty($config['generic_controller']) && $config['generic_controller'] !== $defaultController) {
             $dynamic->addMethodCall(
                 'addRouteEnhancer',

Enhancer/FieldByClassEnhancer.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Enhancer;
+
+use Symfony\Component\HttpFoundation\Request;
+use Metadata\MetadataFactoryInterface;
+use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface;
+
+/**
+ * This enhancer performs the same role as its counterpart
+ * in the Routing component, but it uses the Metadata factory.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class FieldByClassEnhancer implements RouteEnhancerInterface
+{
+    /**
+     * @var string field for the className class
+     */
+    protected $classField;
+
+    /**
+     * @var string field to write hashmap lookup result into
+     */
+    protected $targetField;
+
+    /**
+     * @var string field to write hashmap lookup result into
+     */
+    protected $metaField;
+
+    /**
+     * @var Metadata\MetadataFactoryInterface
+     */
+    protected $metadataFactory;
+
+    /**
+     * @param string $className the field name of the class
+     * @param string $targetField the field name to set from the map
+     * @param array  $map    the map of class names to field values
+     */
+    public function __construct(
+        $classField,
+        $targetField, 
+        $metaField,
+        MetadataFactoryInterface $metadataFactory
+    )
+    {
+        $this->classField = $classField;
+        $this->targetField = $targetField;
+        $this->metaField = $metaField;
+        $this->metadataFactory = $metadataFactory;
+    }
+
+    /**
+     * If the class name is mapped
+     *
+     * {@inheritDoc}
+     */
+    public function enhance(array $defaults, Request $request)
+    {
+        if (isset($defaults[$this->targetField])) {
+            return $defaults;
+        }
+
+        // return if the field containg the class name has not been set
+        if (! isset($defaults[$this->classField])) {
+            return $defaults;
+        }
+
+        $className = get_class($defaults[$this->classField]);
+
+        $meta = $this->metadataFactory->getMetadataForClass($className);
+
+        if (null !== $meta) {
+            $meta = $meta->getOutsideClassMetadata();
+            if (null !== $meta->{$this->metaField}) {
+                $defaults[$this->targetField] = $meta->{$this->metaField};
+            }
+        }
+
+        return $defaults;
+    }
+}

Metadata/Annotations/Controller.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Metadata\Annotations;
+
+/**
+ * @Annotation
+ */
+class Controller
+{
+    public $controller;
+}

Metadata/Annotations/Template.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Metadata\Annotations;
+
+/**
+ * @Annotation
+ */
+class Template
+{
+    public $resource;
+}

Metadata/ClassMetadata.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Metadata;
+
+use Metadata\ClassMetadata as BaseClassMetadata;
+
+class ClassMetadata extends BaseClassMetadata
+{
+    public $template;
+    public $controller;
+}

Metadata/Driver/AbstractDriver.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Metadata\Driver;
+
+use Metadata\Driver\DriverInterface;
+use Symfony\Cmf\Bundle\RoutingBundle\Metadata\ClassMetadata;
+
+abstract class AbstractDriver implements DriverInterface
+{
+    public function validateMetadata(ClassMetadata $meta)
+    {
+        if (
+            null !== $meta->template &&
+            null == $meta->controller
+        ) {
+            throw new \InvalidArgumentException(sprintf(
+                'Template specified for class "%s" but no controller specified.' .PHP_EOL.
+                'You must either explicitly map a controller to the class or define'.PHP_EOL.
+                'a "generic_controller" in the main configuration.'
+            , $meta->name));
+        }
+    }
+}

Metadata/Driver/AnnotationDriver.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Metadata\Driver;
+
+use Symfony\Cmf\Bundle\RoutingBundle\Metadata\ClassMetadata;
+use Doctrine\Common\Annotations\Reader;
+
+class AnnotationDriver extends AbstractDriver
+{
+    protected $reader;
+    protected $genericController;
+
+    /**
+     * @param AnnotationReader $reader
+     */
+    public function __construct(Reader $reader)
+    {
+        $this->reader = $reader;
+    }
+
+    public function setGenericController($genericController)
+    {
+        $this->genericController = $genericController;
+    }
+
+    public function loadMetadataForClass(\ReflectionClass $class)
+    {
+        $templateAnnotation = $this->reader->getClassAnnotation(
+            $class,
+            'Symfony\Cmf\Bundle\RoutingBundle\Metadata\Annotations\Template'
+        );
+        $controllerAnnotation = $this->reader->getClassAnnotation(
+            $class,
+            'Symfony\Cmf\Bundle\RoutingBundle\Metadata\Annotations\Controller'
+        );
+
+
+        $meta = new ClassMetadata($class->name);
+
+        if (null !== $templateAnnotation) {
+            $meta->template = $templateAnnotation->resource;
+        }
+
+        if (null !== $controllerAnnotation) {
+            $meta->controller = $controllerAnnotation->controller;
+        }
+
+        if (null === $meta->controller) {
+            $meta->controller = $this->genericController;
+        }
+
+        $this->validateMetadata($meta);
+
+        return $meta;
+    }
+}