Ability to add route requirements

Ability to set default route to be used for @id generation

Author: Jérémy Hubert

Api/IriConverter.php

@@ -141,6 +141,18 @@ private function getRouteName(ResourceInterface $resource, $prefix)
             return $this->routeCache[$resource][$key];
         }
 
+        if ($resource instanceof RoutedResourceInterface) {
+            $method    = 'get' . ucfirst($key);
+            $routeName = $resource->$method();
+            if ($routeName) {
+                $data                        = $this->routeCache[$resource];
+                $data[$key]                  = $routeName;
+                $this->routeCache[$resource] = $data;
+
+                return $data[$key];
+            }
+        }
+
         $operations = 'item' === $prefix ? $resource->getItemOperations() : $resource->getCollectionOperations();
         foreach ($operations as $operation) {
             $methods = $operation->getRoute()->getMethods();

Api/Operation/OperationFactory.php

@@ -39,6 +39,7 @@ class OperationFactory
      * @param null              $controller
      * @param null              $routeName
      * @param array             $context
+     * @param array             $requirements
      *
      * @return Operation
      */
@@ -48,9 +49,10 @@ public function createCollectionOperation(
         $path = null,
         $controller = null,
         $routeName = null,
-        array $context = []
+        array $context = [],
+        $requirements = []
     ) {
-        return $this->createOperation($resource, true, $methods, $path, $controller, $routeName, $context);
+        return $this->createOperation($resource, true, $methods, $path, $controller, $routeName, $context, $requirements);
     }
 
     /**
@@ -62,6 +64,7 @@ public function createCollectionOperation(
      * @param null              $controller
      * @param null              $routeName
      * @param array             $context
+     * @param array             $requirements
      *
      * @return Operation
      */
@@ -71,9 +74,10 @@ public function createItemOperation(
         $path = null,
         $controller = null,
         $routeName = null,
-        array $context = []
+        array $context = [],
+        $requirements = []
     ) {
-        return $this->createOperation($resource, false, $methods, $path, $controller, $routeName, $context);
+        return $this->createOperation($resource, false, $methods, $path, $controller, $routeName, $context, $requirements);
     }
 
     /**
@@ -86,6 +90,7 @@ public function createItemOperation(
      * @param string|null       $controller
      * @param string|null       $routeName
      * @param array             $context
+     * @param array             $requirements
      *
      * @return Operation
      */
@@ -96,7 +101,8 @@ private function createOperation(
         $path = null,
         $controller = null,
         $routeName = null,
-        array $context = []
+        array $context = [],
+        $requirements = []
     ) {
         $shortName = $resource->getShortName();
 
@@ -143,7 +149,7 @@ private function createOperation(
                     '_controller' => $controller,
                     '_resource' => $shortName,
                 ],
-                [],
+                $requirements,
                 [],
                 '',
                 [],

Api/Resource.php

@@ -20,7 +20,7 @@
  *
  * @author Kévin Dunglas <[email protected]>
  */
-class Resource implements ResourceInterface
+class Resource implements RoutedResourceInterface
 {
     /**
      * @var string
@@ -54,6 +54,14 @@ class Resource implements ResourceInterface
      * @var string|null
      */
     private $shortName;
+    /**
+     * @var string|null
+     */
+    private $itemRouteName;
+    /**
+     * @var string|null
+     */
+    private $collectionRouteName;
 
     /**
      * @param string $entityClass
@@ -227,4 +235,36 @@ public function getShortName()
     {
         return $this->shortName;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getItemRouteName()
+    {
+        return $this->itemRouteName;
+    }
+
+    /**
+     * @param string|null $itemRouteName
+     */
+    public function setItemRouteName($itemRouteName)
+    {
+        $this->itemRouteName = $itemRouteName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getCollectionRouteName()
+    {
+        return $this->collectionRouteName;
+    }
+
+    /**
+     * @param string|null $collectionRouteName
+     */
+    public function setCollectionRouteName($collectionRouteName)
+    {
+        $this->collectionRouteName = $collectionRouteName;
+    }
 }

Api/RoutedResourceInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the DunglasApiBundle 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\ApiBundle\Api;
+
+/**
+ * Class representing an API resource able to specify its item and collection route name.
+ *
+ * @author Jérémy Hubert <[email protected]>
+ */
+interface RoutedResourceInterface extends ResourceInterface
+{
+    /**
+     * Gets the item route name of the resource (for @id generation).
+     *
+     * @return string|null
+     */
+    public function getItemRouteName();
+
+    /**
+     * Gets the collection route name of the resource (for @id generation).
+     *
+     * @return string|null
+     */
+    public function getCollectionRouteName();
+}

Tests/Api/Operation/OperationFactoryTest.php

@@ -48,17 +48,18 @@ public function testCreateCollectionOperationWithDefaultValues()
     public function testCreateCollectionOperationWithAllParameters()
     {
         $operation = $this->operationFactory->createCollectionOperation(
-            $this->resource, ['GET', 'HEAD'], '/bar', 'AppBundle:Test:cget', 'baz', ['kevin' => 'dunglas']
+            $this->resource, ['GET', 'HEAD'], '/bar/{baz}', 'AppBundle:Test:cget', 'qux', ['kevin' => 'dunglas'], ['baz' => '\d']
         );
 
-        $this->assertEquals('/bar', $operation->getRoute()->getPath());
+        $this->assertEquals('/bar/{baz}', $operation->getRoute()->getPath());
         $this->assertEquals(['GET', 'HEAD'], $operation->getRoute()->getMethods());
+        $this->assertArrayHasKey('baz', $operation->getRoute()->getRequirements());
 
         $defaults = $operation->getRoute()->getDefaults();
         $this->assertEquals('AppBundle:Test:cget', $defaults['_controller']);
         $this->assertEquals('Foo', $defaults['_resource']);
 
-        $this->assertEquals('baz', $operation->getRouteName());
+        $this->assertEquals('qux', $operation->getRouteName());
         $this->assertEquals(['kevin' => 'dunglas'], $operation->getContext());
     }
 
@@ -80,11 +81,12 @@ public function testCreateItemOperationWithDefaultValues()
     public function testCreateItemOperationWithAllParameters()
     {
         $operation = $this->operationFactory->createItemOperation(
-            $this->resource, ['GET', 'HEAD'], '/bar/{id}', 'AppBundle:Test:cget', 'baz', ['kevin' => 'dunglas']
+            $this->resource, ['GET', 'HEAD'], '/bar/{id}', 'AppBundle:Test:cget', 'baz', ['kevin' => 'dunglas'], ['id' => '\d']
         );
 
         $this->assertEquals('/bar/{id}', $operation->getRoute()->getPath());
         $this->assertEquals(['GET', 'HEAD'], $operation->getRoute()->getMethods());
+        $this->assertArrayHasKey('id', $operation->getRoute()->getRequirements());
 
         $defaults = $operation->getRoute()->getDefaults();
         $this->assertEquals('AppBundle:Test:cget', $defaults['_controller']);