Merge pull request #200 from symfony-cmf/route_collection

updated for RouteCollection support

Author: lsmith77

DependencyInjection/CmfRoutingExtension.php

@@ -92,6 +92,7 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         $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']);
 
         $locales = false;
         if (isset($config['locales'])) {

DependencyInjection/Configuration.php

@@ -56,6 +56,7 @@ public function getConfigTreeBuilder()
                     ->addDefaultsIfNotSet()
                     ->canBeEnabled()
                     ->children()
+                        ->scalarNode('route_collection_limit')->defaultNull()->end()
                         ->scalarNode('generic_controller')->defaultNull()->end()
                         ->scalarNode('default_controller')->defaultNull()->end()
                         ->arrayNode('controllers_by_type')

Doctrine/DoctrineProvider.php

@@ -44,8 +44,16 @@ abstract class DoctrineProvider
      */
     protected $className;
 
+    /**
+     * Limit to apply when calling getRoutesByNames() with null
+     *
+     * @var integer|null
+     */
+    protected $routeCollectionLimit;
+
     /**
      * @param ManagerRegistry $managerRegistry
+     * @param string $className
      */
     public function __construct(ManagerRegistry $managerRegistry, $className = null)
     {
@@ -64,6 +72,17 @@ public function setManagerName($managerName)
         $this->managerName = $managerName;
     }
 
+    /**
+     * Set the limit to apply when calling getRoutesByNames() with null.
+     * Note that setting the limit to null means no limit applied.
+     *
+     * @param integer|null $routeCollectionLimit
+     */
+    public function setRouteCollectionLimit($routeCollectionLimit = null)
+    {
+        $this->routeCollectionLimit = $routeCollectionLimit;
+    }
+
     /**
      * Get the object manager named $managerName from the registry.
      *

Doctrine/Orm/RouteProvider.php

@@ -73,8 +73,20 @@ public function getRouteByName($name, $parameters = array())
     /**
      * {@inheritDoc}
      */
-    public function getRoutesByNames($names, $parameters = array())
+    public function getRoutesByNames($names = null, $parameters = array())
     {
+        if (null === $names) {
+            $names = array();
+            if (0 === $this->routeCollectionLimit) {
+                return $names;
+            }
+            if (null !== $this->routeCollectionLimit) {
+                return $this->getRoutesRepository()->findBy(array(), null, $this->routeCollectionLimit);
+            }
+
+            return $this->getRoutesRepository()->findAll();
+        }
+
         $routes = array();
         foreach ($names as $name) {
             try {

Doctrine/Phpcr/RouteProvider.php

@@ -12,8 +12,13 @@
 
 namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
 
+use Doctrine\ODM\PHPCR\DocumentManager;
+
+use PHPCR\Query\QueryInterface;
 use PHPCR\RepositoryException;
 
+use PHPCR\Query\RowInterface;
+
 use Symfony\Component\Routing\Route as SymfonyRoute;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Routing\Exception\RouteNotFoundException;
@@ -70,7 +75,9 @@ public function getRouteCollectionForRequest(Request $request)
         }
 
         try {
-            $routes = $this->getObjectManager()->findMany($this->className, $candidates);
+            /** @var $dm DocumentManager */
+            $dm = $this->getObjectManager();
+            $routes = $dm->findMany($this->className, $candidates);
             // filter for valid route objects
             foreach ($routes as $key => $route) {
                 if ($route instanceof SymfonyRoute) {
@@ -135,11 +142,50 @@ public function getRouteByName($name, $parameters = array())
         return $route;
     }
 
+    /**
+     * Get list of route names
+     *
+     * @return array
+     */
+    private function getRouteNames()
+    {
+        if (0 === $this->routeCollectionLimit) {
+            return array();
+        }
+
+        /** @var $dm DocumentManager */
+        $dm = $this->getObjectManager();
+        $sql2 = 'SELECT * FROM [nt:unstructured] WHERE [phpcr:classparents] = '.$dm->quote('Symfony\Component\Routing\Route');
+
+        if ('' !== $this->idPrefix) {
+            $sql2.= ' AND ISDESCENDANTNODE('.$dm->quote($this->idPrefix).')';
+        }
+
+        $query = $dm->createPhpcrQuery($sql2, QueryInterface::JCR_SQL2);
+        if (null !== $this->routeCollectionLimit) {
+            $query->setLimit($this->routeCollectionLimit);
+        }
+
+        $result = $query->execute();
+
+        $names = array();
+        foreach ($result as $row) {
+            /** @var $row RowInterface */
+            $names[] = $row->getPath();
+        }
+
+        return $names;
+    }
+
     /**
      * {@inheritDoc}
      */
-    public function getRoutesByNames($names, $parameters = array())
+    public function getRoutesByNames($names = null, $parameters = array())
     {
+        if (null === $names) {
+            $names = $this->getRouteNames();
+        }
+
         if ('' !== $this->idPrefix) {
             foreach ($names as $key => $name) {
                 if (0 !== strpos($name, $this->idPrefix)) {
@@ -148,7 +194,9 @@ public function getRoutesByNames($names, $parameters = array())
             }
         }
 
-        $collection = $this->getObjectManager()->findMany($this->className, $names);
+        /** @var $dm DocumentManager */
+        $dm = $this->getObjectManager();
+        $collection = $dm->findMany($this->className, $names);
         foreach ($collection as $key => $document) {
             if (!$document instanceof SymfonyRoute) {
                 // we follow the logic of DocumentManager::findMany and do not throw an exception
@@ -158,5 +206,4 @@ public function getRoutesByNames($names, $parameters = array())
 
         return $collection;
     }
-
 }

Resources/config/provider-orm.xml

@@ -20,6 +20,7 @@
             <argument type="service" id="doctrine"/>
             <argument>%cmf_routing.route_entity.class%</argument>
             <call method="setManagerName"><argument>%cmf_routing.dynamic.persistence.orm.manager_name%</argument></call>
+            <call method="setRouteCollectionLimit"><argument>%cmf_routing.route_collection_limit%</argument></call>
         </service>
     </services>
 </container>

Resources/config/provider-phpcr.xml

@@ -17,6 +17,7 @@
             <argument>%cmf_routing.route_model.class%</argument>
             <call method="setManagerName"><argument>%cmf_routing.dynamic.persistence.phpcr.manager_name%</argument></call>
             <call method="setPrefix"><argument>%cmf_routing.dynamic.persistence.phpcr.route_basepath%</argument></call>
+            <call method="setRouteCollectionLimit"><argument>%cmf_routing.route_collection_limit%</argument></call>
         </service>
 
         <service id="cmf_routing.phpcr_content_repository" class="%cmf_routing.content_repository.class%">

Resources/config/routing-dynamic.xml

@@ -67,6 +67,7 @@
             <argument type="service" id="cmf_routing.generator" />
             <argument>%cmf_routing.uri_filter_regexp%</argument>
             <argument type="service" id="event_dispatcher" on-invalid="ignore"/>
+            <argument type="service" id="cmf_routing.route_provider"/>
             <call method="setContainer"><argument type="service" id="service_container"/></call>
             <call method="addRouteEnhancer">
                 <argument type="service" id="cmf_routing.enhancer.route_content"/>

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -39,6 +39,7 @@ public function testSupportsAllConfigFormats()
                 'replace_symfony_router' => true,
             ),
             'dynamic' => array(
+                'route_collection_limit' => null,
                 'generic_controller' => 'acme_main.controller:mainAction',
                 'controllers_by_type' => array(
                     'editable' => 'acme_main.some_controller:editableAction',

composer.json

@@ -15,7 +15,7 @@
     "prefer-stable": false,
     "require": {
         "php": ">=5.3.3",
-        "symfony-cmf/routing": "1.1.*",
+        "symfony-cmf/routing": "~1.2.0",
         "symfony/framework-bundle": "~2.2"
     },
     "require-dev": {
@@ -43,7 +43,7 @@
     "target-dir": "Symfony/Cmf/Bundle/RoutingBundle",
     "extra": {
         "branch-alias": {
-            "dev-master": "1.1-dev"
+            "dev-master": "1.2-dev"
         }
     }
 }