fix documentation & tests

Author: usu

api/src/Entity/ContentNode.php

@@ -38,7 +38,7 @@
     denormalizationContext: ['groups' => ['write']],
     normalizationContext: ['groups' => ['read']],
 )]
-#[ApiFilter(SearchFilter::class, properties: ['parent'])]
+#[ApiFilter(SearchFilter::class, properties: ['parent', 'contentType'])]
 abstract class ContentNode extends BaseEntity implements BelongsToCampInterface {
     /**
      * @ORM\OneToOne(targetEntity="AbstractContentNodeOwner", mappedBy="rootContentNode", cascade={"persist", "remove"})

api/src/Entity/ContentType.php

@@ -46,7 +46,6 @@ class ContentType extends BaseEntity {
      * @ORM\Column(type="text")
      */
     #[ApiProperty(writable: false)]
-    #[Groups(['read'])]
     public ?string $entityClass = null;
 
     /**
@@ -59,10 +58,17 @@ class ContentType extends BaseEntity {
     public ?array $jsonConfig = [];
 
     /**
-     * API endpoint path for creating new entities of type entityClass.
+     * API endpoint link for creating new entities of type entityClass.
      */
     #[Groups(['read'])]
-    public function getEntityPath(): string {
-        return ''; // empty here; actual content of this property is filled/decorated in ContentTypeNormalizer
+    #[ApiProperty(
+        example: '/content_node/column_layouts?contentType=%2Fcontent_types%2F1a2b3c4d',
+        openapiContext: [
+            'type' => 'array',
+            'format' => 'iri-reference',
+        ]
+    )]
+    public function getContentNodes(): array {
+        return []; // empty here; actual content is filled/decorated in ContentTypeNormalizer
     }
 }

api/src/Serializer/Normalizer/ContentTypeNormalizer.php

@@ -2,19 +2,23 @@
 
 namespace App\Serializer\Normalizer;
 
+use ApiPlatform\Core\Api\IriConverterInterface;
 use App\Entity\ContentType;
 use App\Metadata\Resource\Factory\UriTemplateFactory;
+use Rize\UriTemplate;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\SerializerAwareInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
- * ...
+ * Adds API link to contentNodes for ContentType based on the defined 'entityClass'.
  */
 class ContentTypeNormalizer implements NormalizerInterface, SerializerAwareInterface {
     public function __construct(
         private NormalizerInterface $decorated,
+        private UriTemplate $uriTemplate,
         private UriTemplateFactory $uriTemplateFactory,
+        private IriConverterInterface $iriConverter,
     ) {
     }
 
@@ -25,12 +29,16 @@ public function supportsNormalization($data, $format = null) {
     public function normalize($object, $format = null, array $context = []) {
         $data = $this->decorated->normalize($object, $format, $context);
 
-        if ($object instanceof ContentType && isset($data['entityClass'])) {
-            [$uriTemplate, $templated] = $this->uriTemplateFactory->createFromResourceClass($data['entityClass']);
-            $data['_links']['contentNodes']['href'] = $uriTemplate;
-            $data['_links']['contentNodes']['templated'] = $templated;
+        if ($object instanceof ContentType && isset($object->entityClass)) {
+            // get uri for the respective ContentNode entity and add ContentType as query parameter
+            [$uriTemplate, $templated] = $this->uriTemplateFactory->createFromResourceClass($object->entityClass);
+            $uri = $this->uriTemplate->expand($uriTemplate, ['contentType' => $this->iriConverter->getIriFromItem($object)]);
 
-            unset($data['entityClass']);
+            // add uri as HAL link
+            $data['_links']['contentNodes']['href'] = $uri;
+
+            // unset the property itself (property definition was only needed to ensure proper API documentation)
+            unset($data['contentNodes']);
         }
 
         return $data;

api/tests/Serializer/Normalizer/ContentTypeNormalizerTest.php

@@ -2,11 +2,14 @@
 
 namespace App\Tests\Serializer\Normalizer;
 
+use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameResolverInterface;
 use App\Entity\ContentType;
+use App\Metadata\Resource\Factory\UriTemplateFactory;
 use App\Serializer\Normalizer\ContentTypeNormalizer;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Rize\UriTemplate;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
@@ -21,16 +24,22 @@ class ContentTypeNormalizerTest extends TestCase {
     private MockObject|NormalizerInterface $decoratedMock;
     private MockObject|RouteNameResolverInterface $routeNameResolver;
     private MockObject|RouterInterface $routerMock;
+    private MockObject|IriConverterInterface $iriConverter;
+    private MockObject|UriTemplate $uriTemplate;
+    private MockObject|UriTemplateFactory $uriTemplateFactory;
 
     protected function setUp(): void {
         $this->decoratedMock = $this->createMock(ContextAwareNormalizerInterface::class);
-        $this->routeNameResolver = $this->createMock(RouteNameResolverInterface::class);
-        $this->routerMock = $this->createMock(RouterInterface::class);
+
+        $this->iriConverter = $this->createMock(IriConverterInterface::class);
+        $this->uriTemplate = $this->createMock(UriTemplate::class);
+        $this->uriTemplateFactory = $this->createMock(UriTemplateFactory::class);
 
         $this->normalizer = new ContentTypeNormalizer(
             $this->decoratedMock,
-            $this->routeNameResolver,
-            $this->routerMock,
+            $this->uriTemplate,
+            $this->uriTemplateFactory,
+            $this->iriConverter,
         );
         $this->normalizer->setSerializer($this->createMock(SerializerInterface::class));
     }
@@ -58,39 +67,45 @@ public function testDelegatesNormalizeToDecorated() {
         ;
 
         // when
-        $result = $this->normalizer->normalize($resource, null, ['resource_class' => DummyEntity::class]);
+        $result = $this->normalizer->normalize($resource, null, ['resource_class' => \stdClass::class]);
 
         // then
         $this->assertEquals($delegatedResult, $result);
     }
 
     public function testNormalizeAddsEntityPath() {
         // given
-        $resource = new ContentType();
+        $contentType = new ContentType();
+        $contentType->entityClass = 'App\Entity\ContentNode\DummyContentNode';
+
         $delegatedResult = [
             'hello' => 'world',
-            'entityClass' => 'DummyClass',
         ];
         $this->decoratedMock->expects($this->once())
             ->method('normalize')
             ->willReturn($delegatedResult)
          ;
-        $this->routerMock->expects($this->once())
-            ->method('generate')
-            ->willReturn('/path')
+        $this->uriTemplateFactory->expects($this->once())
+            ->method('createFromResourceClass')
+            ->willReturn(['/templatedUri', 'true'])
         ;
-        $this->routeNameResolver->expects($this->once())
-            ->method('getRouteName')
+
+        $this->uriTemplate->expects($this->once())
+            ->method('expand')
+            ->willReturn('/expandedUri')
         ;
 
         // when
-        $result = $this->normalizer->normalize($resource, null, ['resource_class' => DummyEntity::class]);
+        $result = $this->normalizer->normalize($contentType, null, ['resource_class' => ContentType::class]);
 
         // then
         $expectedResult = [
             'hello' => 'world',
-            'entityClass' => 'DummyClass',
-            'entityPath' => '/path',
+            '_links' => [
+                'contentNodes' => [
+                    'href' => '/expandedUri',
+                ],
+            ],
         ];
         $this->assertEquals($expectedResult, $result);
     }