move document to model

Admin/RouteAdmin.php

@@ -9,6 +9,7 @@
 use Sonata\DoctrinePHPCRAdminBundle\Admin\Admin;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+use PHPCR\Util\PathHelper;
 
 class RouteAdmin extends Admin
 {
@@ -74,7 +75,8 @@ protected function configureDatagridFilters(DatagridMapper $datagridMapper)
 
     public function setRouteRoot($routeRoot)
     {
-        $this->routeRoot = $routeRoot;
+        // TODO: fix widget to show root node when root is selectable
+        $this->routeRoot = PathHelper::getParentPath($routeRoot);
     }
 
     public function setContentRoot($contentRoot)

CHANGELOG.md

@@ -1,10 +1,11 @@
 Changelog
 =========
 
+* **2013-07-19**: [Model] Separated database agnostic, doctrine generic and
+  PHPCR-ODM specific code to prepare for Doctrine ORM support.
 * **2013-07-17**: [FormType] Moved TermsFormType to CoreBundle and renamed it to CheckboxUrlLableFormType
 
 1.1.0-beta2
------------
 
 * **2013-05-28**: [Bundle] Only include Doctrine PHPCR compiler pass if PHPCR-ODM is present
 * **2013-05-25**: [Bundle] Drop symfony_ from symfony_cmf prefix

CmfRoutingBundle.php

@@ -27,6 +27,15 @@ public function build(ContainerBuilder $container)
 
         if (class_exists('Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass')) {
             $container->addCompilerPass($this->buildBasePhpcrCompilerPass());
+            $container->addCompilerPass(
+                DoctrinePhpcrMappingsPass::createXmlMappingDriver(
+                    array(
+                        realpath(__DIR__ . '/Resources/config/doctrine-model') => 'Symfony\Cmf\Bundle\RoutingBundle\Model',
+                        realpath(__DIR__ . '/Resources/config/doctrine-phpcr') => 'Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr',
+                    ),
+                    array('cmf_routing.manager_name')
+                )
+            );
         }
     }
 
@@ -47,7 +56,7 @@ private function buildBasePhpcrCompilerPass()
             $driver,
             array('Symfony\Component\Routing'),
             array('cmf_routing.manager_name'),
-            false // TODO: once we have config for orm or phpcr-odm, configure the enabled parameter
+            'cmf_routing.backend_type_phpcr'
         );
     }
 }

DependencyInjection/CmfRoutingExtension.php

@@ -43,10 +43,6 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         $this->setupFormTypes($config, $container, $loader);
-
-        if ($config['use_sonata_admin']) {
-            $this->loadSonataAdmin($config, $loader, $container);
-        }
     }
 
     public function setupFormTypes(array $config, ContainerBuilder $container, LoaderInterface $loader)
@@ -87,22 +83,18 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         $container->setParameter($this->getAlias() . '.defined_templates_class', $controllerForTemplates);
         $container->setParameter($this->getAlias() . '.uri_filter_regexp', $config['uri_filter_regexp']);
 
-        $loader->load('cmf_routing.xml');
-        $container->setParameter($this->getAlias() . '.routing_repositoryroot', $config['routing_repositoryroot']);
-        if (isset($config['locales']) && $config['locales']) {
-            $container->setParameter($this->getAlias() . '.locales', $config['locales']);
-        } else {
-            $container->removeDefinition('cmf_routing.phpcrodm_route_localeupdater_listener');
-        }
+        $loader->load('dynamic_routing.xml');
 
-        $container->setAlias('cmf_routing.route_provider', $config['route_provider_service_id']);
-        $container->setAlias('cmf_routing.content_repository', $config['content_repository_service_id']);
+        if (isset($config['phpcr_provider'])) {
+            $this->loadPhpcrProvider($config['phpcr_provider'], $loader, $container);
+        }
 
-        $routeProvider = $container->getDefinition($this->getAlias() . '.default_route_provider');
-        $routeProvider->replaceArgument(0, new Reference($config['manager_registry']));
-        $contentRepository = $container->getDefinition($this->getAlias() . '.default_content_repository');
-        $contentRepository->replaceArgument(0, new Reference($config['manager_registry']));
-        $container->setParameter($this->getAlias() . '.manager_name', $config['manager_name']);
+        if (isset($config['route_provider_service_id'])) {
+            $container->setAlias('cmf_routing.route_provider', $config['route_provider_service_id']);
+        }
+        if (isset($config['content_repository_service_id'])) {
+            $container->setAlias('cmf_routing.content_repository', $config['content_repository_service_id']);
+        }
 
         $dynamic = $container->getDefinition($this->getAlias().'.dynamic_router');
 
@@ -128,16 +120,43 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
     }
 
-    public function loadSonataAdmin($config, XmlFileLoader $loader, ContainerBuilder $container)
+    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container)
+    {
+        $loader->load('provider_phpcr.xml');
+
+        $container->setParameter($this->getAlias() . '.backend_type_phpcr', true);
+
+        $container->setParameter($this->getAlias() . '.phpcr_provider.route_basepath', $config['route_basepath']);
+        $container->setParameter($this->getAlias() . '.phpcr_provider.content_basepath', $config['content_basepath']);
+
+        $routeProvider = $container->getDefinition($this->getAlias() . '.phpcr_route_provider');
+        $routeProvider->replaceArgument(0, new Reference($config['manager_registry']));
+        $contentRepository = $container->getDefinition($this->getAlias() . '.phpcr_content_repository');
+        $contentRepository->replaceArgument(0, new Reference($config['manager_registry']));
+        $container->setParameter($this->getAlias() . '.manager_name', $config['manager_name']);
+
+        $container->setAlias($this->getAlias() . '.route_provider', $this->getAlias() . '.phpcr_route_provider');
+        $container->setAlias($this->getAlias() . '.content_repository', $this->getAlias() . '.phpcr_content_repository');
+
+        if (isset($config['locales']) && $config['locales']) {
+            $container->setParameter($this->getAlias() . '.locales', $config['locales']);
+        } else {
+            $container->removeDefinition('cmf_routing.phpcrodm_route_locale_listener');
+        }
+
+        if ($config['use_sonata_admin']) {
+            $this->loadSonataPhpcrAdmin($config, $loader, $container);
+        }
+    }
+
+    public function loadSonataPhpcrAdmin($config, XmlFileLoader $loader, ContainerBuilder $container)
     {
         $bundles = $container->getParameter('kernel.bundles');
         if ('auto' === $config['use_sonata_admin'] && !isset($bundles['SonataDoctrinePHPCRAdminBundle'])) {
             return;
         }
 
-        $loader->load('routing-admin.xml');
-        $container->setParameter($this->getAlias() . '.content_basepath', $config['content_basepath']);
-        $container->setParameter($this->getAlias() . '.route_basepath', $config['route_basepath']);
+        $loader->load('admin_phpcr.xml');
     }
 
     /**

DependencyInjection/Configuration.php

@@ -58,29 +58,31 @@ public function getConfigTreeBuilder()
                             ->useAttributeAsKey('alias')
                             ->prototype('scalar')->end()
                         ->end()
-                        ->scalarNode('manager_registry')->defaultValue('doctrine_phpcr')->end()
-                        ->scalarNode('manager_name')->defaultValue('default')->end()
+                        ->arrayNode('phpcr_provider')
+                            ->children()
+                                ->scalarNode('manager_registry')->defaultValue('doctrine_phpcr')->end()
+                                ->scalarNode('manager_name')->defaultNull()->end()
+                                ->scalarNode('route_basepath')->defaultValue('/cms/routes')->end()
+                                ->scalarNode('content_basepath')->defaultValue('/cms/content')->end()
+                                ->enumNode('use_sonata_admin')
+                                    ->values(array(true, false, 'auto'))
+                                    ->defaultValue('auto')
+                                ->end()
+                            ->end()
+                        ->end()
                         ->scalarNode('uri_filter_regexp')->defaultValue('')->end()
-                        ->scalarNode('route_provider_service_id')->defaultValue('cmf_routing.default_route_provider')->end()
+                        ->scalarNode('route_provider_service_id')->end()
                         ->arrayNode('route_filters_by_id')
                             ->canBeUnset()
                             ->useAttributeAsKey('id')
                             ->prototype('scalar')->end()
                         ->end()
-                        ->scalarNode('content_repository_service_id')->defaultValue('cmf_routing.default_content_repository')->end()
-                        ->scalarNode('routing_repositoryroot')->defaultValue('/cms/routes')->end()
+                        ->scalarNode('content_repository_service_id')->end()
                         ->arrayNode('locales')
                             ->prototype('scalar')->end()
                         ->end()
                     ->end()
                 ->end()
-                ->enumNode('use_sonata_admin')
-                    ->values(array(true, false, 'auto'))
-                    ->defaultValue('auto')
-                ->end()
-                ->scalarNode('content_basepath')->defaultValue('/cms/content')->end()
-                // TODO: fix widget to show root node when root is selectable, then use routing_repositoryroot for both
-                ->scalarNode('route_basepath')->defaultValue('/cms')->end()
             ->end()
         ;
 

Doctrine/DoctrineProvider.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine;
+
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\Common\Persistence\ObjectManager;
+
+/**
+ * Abstract class for doctrine based content repository and route provider
+ * implementations.
+ *
+ * @author Uwe Jäger
+ * @author David Buchmann <mail@davidbu.ch>
+ */
+abstract class DoctrineProvider
+{
+    /**
+     * If this is null, the manager registry will return the default manager.
+     *
+     * @var string|null Name of object manager to use
+     */
+    protected $managerName;
+
+    /**
+     * @var ManagerRegistry
+     */
+    protected $managerRegistry;
+
+    /**
+     * Class name of the object class to find, null for PHPCR-ODM as it can
+     * determine the class on its own.
+     *
+     * @var string|null
+     */
+    protected $className;
+
+    /**
+     * @param ManagerRegistry $managerRegistry
+     */
+    public function __construct(ManagerRegistry $managerRegistry, $className = null)
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+
+    /**
+     * Set the object manager name to use for this loader. If not set, the
+     * default manager as decided by the manager registry will be used.
+     *
+     * @param string|null $managerName
+     */
+    public function setManagerName($managerName)
+    {
+        $this->managerName = $managerName;
+    }
+
+    /**
+     * Get the object manager named $managerName from the registry.
+     *
+     * @return ObjectManager
+     */
+    protected function getObjectManager()
+    {
+        return $this->managerRegistry->getManager($this->managerName);
+    }
+}

Doctrine/Phpcr/ContentRepository.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
+
+use Symfony\Cmf\Component\Routing\ContentRepositoryInterface;
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\DoctrineProvider;
+
+/**
+ * Implement ContentRepositoryInterface for PHPCR-ODM
+ *
+ * This is <strong>NOT</strong> not a doctrine repository but just the content
+ * provider for the NestedMatcher. (you could of course implement this
+ * interface in a repository class, if you need that)
+ *
+ * @author Uwe Jäger
+ */
+class ContentRepository extends DoctrineProvider implements ContentRepositoryInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function findById($id)
+    {
+        return $this->getObjectManager()->find(null, $id);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getContentId($content)
+    {
+        if (! is_object($content)) {
+            return null;
+        }
+        try {
+            return $this->getObjectManager()->getUnitOfWork()->getDocumentId($content);
+        } catch (\Exception $e) {
+            return null;
+        }
+    }
+}

Listener/IdPrefix.php → Doctrine/Phpcr/IdPrefixListener.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace Symfony\Cmf\Bundle\RoutingBundle\Listener;
+namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
 
-use Symfony\Cmf\Bundle\RoutingBundle\Document\Route;
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route;
 use Doctrine\Common\Persistence\Event\LifecycleEventArgs;
 
 /**
- * Doctrine PHPCR-ODM listener to set the idPrefix on new routes
+ * Doctrine PHPCR-ODM listener to set the idPrefix on routes
  *
- * @author david.buchmann@liip.ch
+ * @author David Buchmann <mail@davidbu.ch>
  */
-class IdPrefix
+class IdPrefixListener
 {
     /**
      * The prefix to add to the url to create the repository path
@@ -48,7 +48,7 @@ protected function updateId(LifecycleEventArgs $args)
 
         // only update route objects and only if the prefix can match, to allow
         // for more than one listener and more than one route root
-        if ($doc instanceof Route
+        if (($doc instanceof PrefixInterface)
             && ! strncmp($this->idPrefix, $doc->getId(), strlen($this->idPrefix))
         ) {
             $doc->setPrefix($this->idPrefix);

Listener/LocaleUpdater.php → Doctrine/Phpcr/LocaleListener.php

@@ -1,21 +1,22 @@
 <?php
 
-namespace Symfony\Cmf\Bundle\RoutingBundle\Listener;
+namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
 
-use Symfony\Cmf\Bundle\RoutingBundle\Document\Route;
 use Doctrine\ODM\PHPCR\Event\MoveEventArgs;
 use Doctrine\Common\Persistence\Event\LifecycleEventArgs;
 
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route;
+
 /**
  * Doctrine PHPCR-ODM listener to update the locale on routes based on the URL.
  *
  * It uses the idPrefix and looks at the path segment right after the prefix to
  * determine if that segment matches one of the configured locales and if so
  * sets a requirement and default named _locale for that locale.
  *
- * @author David Buchmann <david@liip.ch>
+ * @author David Buchmann <mail@davidbu.ch>
  */
-class LocaleUpdater
+class LocaleListener
 {
     /**
      * The prefix to add to the url to create the repository path

Doctrine/Phpcr/PrefixInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
+
+/**
+ * An interface for PHPCR route documents.
+ *
+ * We use the repository path as static part of the URL, but the documents
+ * need to know what their base path is to remove that from the URL.
+ */
+interface PrefixInterface
+{
+    /**
+     * @return string the full path of this document in the repository.
+     */
+    public function getId();
+
+    /**
+     * @param string $prefix The path in the repository to the routing root
+     *      document.
+     */
+    public function setPrefix($prefix);
+}