added maxDepth to ApiSubresource

Author: Nightbr

src/Annotation/ApiSubresource.php

@@ -23,4 +23,8 @@
  */
 final class ApiSubresource
 {
+    /**
+     * @var int
+     */
+    public $maxDepth;
 }

src/Metadata/Property/Factory/AnnotationSubresourceMetadataFactory.php

@@ -82,7 +82,8 @@ private function updateMetadata(ApiSubresource $annotation, PropertyMetadata $pr
         $type = $propertyMetadata->getType();
         $isCollection = $type->isCollection();
         $resourceClass = $isCollection ? $type->getCollectionValueType()->getClassName() : $type->getClassName();
+        $maxDepth = $annotation->maxDepth ? $annotation->maxDepth : null;
 
-        return $propertyMetadata->withSubresource(new SubresourceMetadata($resourceClass, $isCollection));
+        return $propertyMetadata->withSubresource(new SubresourceMetadata($resourceClass, $isCollection, $maxDepth));
     }
 }

src/Metadata/Property/SubresourceMetadata.php

@@ -22,11 +22,13 @@ final class SubresourceMetadata
 {
     private $resourceClass;
     private $collection;
+    private $maxDepth;
 
-    public function __construct(string $resourceClass, bool $collection = false)
+    public function __construct(string $resourceClass, bool $collection = false, int $maxDepth = null)
     {
         $this->resourceClass = $resourceClass;
         $this->collection = $collection;
+        $this->maxDepth = $maxDepth;
     }
 
     public function getResourceClass(): string
@@ -54,4 +56,12 @@ public function withCollection(bool $collection): self
 
         return $metadata;
     }
+
+    /**
+     * @return int
+     */
+    public function getMaxDepth()
+    {
+        return $this->maxDepth;
+    }
 }

src/Metadata/schema/metadata.xsd

@@ -80,6 +80,7 @@
     <xsd:complexType name="subresource" mixed="true">
         <xsd:attribute type="xsd:boolean" name="collection"/>
         <xsd:attribute type="xsd:string" name="resourceClass"/>
+        <xsd:attribute type="xsd:integer" name="maxDepth"/>
     </xsd:complexType>
 
     <xsd:complexType name="property">

src/Operation/Factory/SubresourceOperationFactory.php

@@ -60,8 +60,10 @@ public function create(string $resourceClass): array
      * @param string $rootResourceClass null on the first iteration, it then keeps track of the origin resource class
      * @param array  $parentOperation   the previous call operation
      * @param array  $visited
+     * @param int    $depth the number of visited
+     * @param int    $maxDepth
      */
-    private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, array $visited = [])
+    private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, array $visited = [], int $depth = 0, int $maxDepth = null)
     {
         if (null === $rootResourceClass) {
             $rootResourceClass = $resourceClass;
@@ -79,6 +81,15 @@ private function computeSubresourceOperations(string $resourceClass, array &$tre
             $subresourceMetadata = $this->resourceMetadataFactory->create($subresourceClass);
 
             $visiting = "$resourceClass $property $subresourceClass";
+
+            // Handle maxDepth
+            if ($rootResourceClass === $resourceClass) {
+                $maxDepth = $subresource->getMaxDepth();
+            }
+
+            if(null !== $maxDepth && $depth >= $maxDepth) {
+                continue;
+            }
             if (isset($visited[$visiting])) {
                 continue;
             }
@@ -154,7 +165,7 @@ private function computeSubresourceOperations(string $resourceClass, array &$tre
 
             $tree[$operation['route_name']] = $operation;
 
-            $this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visited + [$visiting => true]);
+            $this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visited + [$visiting => true], ++$depth, $maxDepth);
         }
     }
 }

tests/Fixtures/FileConfigurations/resources.xml

@@ -54,7 +54,7 @@
                 writableLink="false"
                 required="true"
         >
-            <subresource collection="true" resourceClass="Foo" />
+            <subresource collection="true" resourceClass="Foo" maxDepth="1" />
             <attribute name="foo">
                 <attribute>Foo</attribute>
             </attribute>

tests/Fixtures/FileConfigurations/resources.yml

@@ -28,7 +28,7 @@ resources:
         iri: 'someirischema'
         properties:
             'foo':
-                subresource: {collection: true, resourceClass: 'Foo'}
+                subresource: {collection: true, resourceClass: 'Foo', maxDepth: 1}
                 description: 'The dummy foo'
                 readable: true
                 writable: true

tests/Operation/Factory/SubresourceOperationFactoryTest.php

@@ -259,4 +259,49 @@ public function testCreateByOverriding()
             ] + SubresourceOperationFactory::ROUTE_OPTIONS,
         ], $subresourceOperationFactory->create(DummyEntity::class));
     }
+
+    public function testCreateWithMaxDepth()
+    {
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $resourceMetadataFactoryProphecy->create(RelatedDummyEntity::class)->shouldBeCalled()->willReturn(new ResourceMetadata('relatedDummyEntity'));
+        $resourceMetadataFactoryProphecy->create(DummyEntity::class)->shouldBeCalled()->willReturn(new ResourceMetadata('dummyEntity'));
+
+        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
+        $propertyNameCollectionFactoryProphecy->create(DummyEntity::class)->shouldBeCalled()->willReturn(new PropertyNameCollection(['subresource']));
+        $propertyNameCollectionFactoryProphecy->create(RelatedDummyEntity::class)->shouldBeCalled()->willReturn(new PropertyNameCollection(['bar', 'anotherSubresource']));
+
+        $subresourceMetadataCollectionWithMaxDepth = (new PropertyMetadata())->withSubresource(new SubresourceMetadata(RelatedDummyEntity::class, false, 1));
+        $anotherSubresourceMetadata = (new PropertyMetadata())->withSubresource(new SubresourceMetadata(DummyEntity::class, false));
+
+        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        $propertyMetadataFactoryProphecy->create(DummyEntity::class, 'subresource')->shouldBeCalled()->willReturn($subresourceMetadataCollectionWithMaxDepth);
+        $propertyMetadataFactoryProphecy->create(RelatedDummyEntity::class, 'bar')->shouldBeCalled()->willReturn(new PropertyMetadata());
+        $propertyMetadataFactoryProphecy->create(RelatedDummyEntity::class, 'anotherSubresource')->shouldBeCalled()->willReturn($anotherSubresourceMetadata);
+
+        $pathSegmentNameGeneratorProphecy = $this->prophesize(PathSegmentNameGeneratorInterface::class);
+        $pathSegmentNameGeneratorProphecy->getSegmentName('dummyEntity', true)->shouldBeCalled()->willReturn('dummy_entities');
+        $pathSegmentNameGeneratorProphecy->getSegmentName('subresource', false)->shouldBeCalled()->willReturn('subresource');
+
+        $subresourceOperationFactory = new SubresourceOperationFactory(
+                $resourceMetadataFactoryProphecy->reveal(),
+                $propertyNameCollectionFactoryProphecy->reveal(),
+                $propertyMetadataFactoryProphecy->reveal(),
+                $pathSegmentNameGeneratorProphecy->reveal()
+        );
+
+        $this->assertEquals([
+            'api_dummy_entities_subresource_get_subresource' => [
+                    'property' => 'subresource',
+                    'collection' => false,
+                    'resource_class' => RelatedDummyEntity::class,
+                    'shortNames' => ['relatedDummyEntity', 'dummyEntity'],
+                    'identifiers' => [
+                        ['id', DummyEntity::class, true],
+                    ],
+                    'route_name' => 'api_dummy_entities_subresource_get_subresource',
+                    'path' => '/dummy_entities/{id}/subresource.{_format}',
+                    'operation_name' => 'subresource_get_subresource',
+                ] + SubresourceOperationFactory::ROUTE_OPTIONS
+        ], $subresourceOperationFactory->create(DummyEntity::class));
+    }
 }