feat: add operation to hydra response

src/Hydra/Serializer/CollectionNormalizer.php

@@ -17,6 +17,7 @@
 use ApiPlatform\JsonLd\Serializer\HydraPrefixTrait;
 use ApiPlatform\JsonLd\Serializer\JsonLdContextTrait;
 use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Serializer\AbstractCollectionNormalizer;
@@ -31,6 +32,7 @@
  */
 final class CollectionNormalizer extends AbstractCollectionNormalizer
 {
+    use HydraOperationsTrait;
     use HydraPrefixTrait;
     use JsonLdContextTrait;
 
@@ -42,7 +44,7 @@ final class CollectionNormalizer extends AbstractCollectionNormalizer
         self::PRESERVE_COLLECTION_KEYS => false,
     ];
 
-    public function __construct(private readonly ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, array $defaultContext = [])
+    public function __construct(private readonly ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, array $defaultContext = [], private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
     {
         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
 
@@ -70,6 +72,31 @@ protected function getPaginationData(iterable $object, array $context = []): arr
             $data[$hydraPrefix.'totalItems'] = \count($object);
         }
 
+        if (null !== $this->resourceMetadataCollectionFactory && ($context['hydra_operations'] ?? $this->defaultContext['hydra_operations'] ?? false)) {
+            $allHydraOperations = [];
+            $operationNames = [];
+            foreach ($this->resourceMetadataCollectionFactory->create($resourceClass) as $resourceMetadata) {
+                $hydraOperations = $this->getHydraOperations(
+                    true,
+                    $resourceMetadata,
+                    $hydraPrefix
+                );
+                if (!empty($hydraOperations)) {
+                    foreach ($hydraOperations as $operation) {
+                        $operationName = $operation['method'];
+                        if (!\in_array($operationName, $operationNames, true)) {
+                            $operationNames[] = $operationName;
+                            $allHydraOperations[] = $operation;
+                        }
+                    }
+                }
+            }
+
+            if (!empty($allHydraOperations)) {
+                $data[$hydraPrefix.'operation'] = $allHydraOperations;
+            }
+        }
+
         return $data;
     }
 

src/Hydra/Serializer/DocumentationNormalizer.php

@@ -21,7 +21,6 @@
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\ErrorResource;
-use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
@@ -48,6 +47,7 @@
  */
 final class DocumentationNormalizer implements NormalizerInterface
 {
+    use HydraOperationsTrait;
     use HydraPrefixTrait;
     public const FORMAT = 'jsonld';
 
@@ -254,106 +254,6 @@ private function getHydraProperties(string $resourceClass, ApiResource $resource
         return $properties;
     }
 
-    /**
-     * Gets Hydra operations.
-     */
-    private function getHydraOperations(bool $collection, ApiResource $resourceMetadata, string $hydraPrefix = ContextBuilder::HYDRA_PREFIX): array
-    {
-        $hydraOperations = [];
-        foreach ($resourceMetadata->getOperations() as $operation) {
-            if (true === $operation->getHideHydraOperation()) {
-                continue;
-            }
-
-            if (('POST' === $operation->getMethod() || $operation instanceof CollectionOperationInterface) !== $collection) {
-                continue;
-            }
-
-            $hydraOperations[] = $this->getHydraOperation($operation, $operation->getShortName(), $hydraPrefix);
-        }
-
-        return $hydraOperations;
-    }
-
-    /**
-     * Gets and populates if applicable a Hydra operation.
-     */
-    private function getHydraOperation(HttpOperation $operation, string $prefixedShortName, string $hydraPrefix): array
-    {
-        $method = $operation->getMethod() ?: 'GET';
-
-        $hydraOperation = $operation->getHydraContext() ?? [];
-        if ($operation->getDeprecationReason()) {
-            $hydraOperation['owl:deprecated'] = true;
-        }
-
-        $shortName = $operation->getShortName();
-        $inputMetadata = $operation->getInput() ?? [];
-        $outputMetadata = $operation->getOutput() ?? [];
-
-        $inputClass = \array_key_exists('class', $inputMetadata) ? $inputMetadata['class'] : false;
-        $outputClass = \array_key_exists('class', $outputMetadata) ? $outputMetadata['class'] : false;
-
-        if ('GET' === $method && $operation instanceof CollectionOperationInterface) {
-            $hydraOperation += [
-                '@type' => [$hydraPrefix.'Operation', 'schema:FindAction'],
-                $hydraPrefix.'description' => "Retrieves the collection of $shortName resources.",
-                'returns' => null === $outputClass ? 'owl:Nothing' : $hydraPrefix.'Collection',
-            ];
-        } elseif ('GET' === $method) {
-            $hydraOperation += [
-                '@type' => [$hydraPrefix.'Operation', 'schema:FindAction'],
-                $hydraPrefix.'description' => "Retrieves a $shortName resource.",
-                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
-            ];
-        } elseif ('PATCH' === $method) {
-            $hydraOperation += [
-                '@type' => $hydraPrefix.'Operation',
-                $hydraPrefix.'description' => "Updates the $shortName resource.",
-                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
-                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
-            ];
-
-            if (null !== $inputClass) {
-                $possibleValue = [];
-                foreach ($operation->getInputFormats() ?? [] as $mimeTypes) {
-                    foreach ($mimeTypes as $mimeType) {
-                        $possibleValue[] = $mimeType;
-                    }
-                }
-
-                $hydraOperation['expectsHeader'] = [['headerName' => 'Content-Type', 'possibleValue' => $possibleValue]];
-            }
-        } elseif ('POST' === $method) {
-            $hydraOperation += [
-                '@type' => [$hydraPrefix.'Operation', 'schema:CreateAction'],
-                $hydraPrefix.'description' => "Creates a $shortName resource.",
-                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
-                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
-            ];
-        } elseif ('PUT' === $method) {
-            $hydraOperation += [
-                '@type' => [$hydraPrefix.'Operation', 'schema:ReplaceAction'],
-                $hydraPrefix.'description' => "Replaces the $shortName resource.",
-                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
-                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
-            ];
-        } elseif ('DELETE' === $method) {
-            $hydraOperation += [
-                '@type' => [$hydraPrefix.'Operation', 'schema:DeleteAction'],
-                $hydraPrefix.'description' => "Deletes the $shortName resource.",
-                'returns' => 'owl:Nothing',
-            ];
-        }
-
-        $hydraOperation[$hydraPrefix.'method'] ??= $method;
-        $hydraOperation[$hydraPrefix.'title'] ??= strtolower($method).$shortName.($operation instanceof CollectionOperationInterface ? 'Collection' : '');
-
-        ksort($hydraOperation);
-
-        return $hydraOperation;
-    }
-
     /**
      * Gets the range of the property.
      */

src/Hydra/Serializer/HydraOperationsTrait.php

@@ -0,0 +1,127 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Hydra\Serializer;
+
+use ApiPlatform\JsonLd\ContextBuilder;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\HttpOperation;
+
+/**
+ * Generates Hydra operations for JSON-LD responses.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+trait HydraOperationsTrait
+{
+    /**
+     * Gets Hydra operations.
+     */
+    private function getHydraOperations(bool $collection, ApiResource $resourceMetadata, string $hydraPrefix = ContextBuilder::HYDRA_PREFIX): array
+    {
+        $hydraOperations = [];
+        foreach ($resourceMetadata->getOperations() as $operation) {
+            if (true === $operation->getHideHydraOperation()) {
+                continue;
+            }
+
+            if (('POST' === $operation->getMethod() || $operation instanceof CollectionOperationInterface) !== $collection) {
+                continue;
+            }
+
+            $hydraOperations[] = $this->getHydraOperation($operation, $operation->getShortName(), $hydraPrefix);
+        }
+
+        return $hydraOperations;
+    }
+
+    /**
+     * Gets and populates if applicable a Hydra operation.
+     */
+    private function getHydraOperation(HttpOperation $operation, string $prefixedShortName, string $hydraPrefix = ContextBuilder::HYDRA_PREFIX): array
+    {
+        $method = $operation->getMethod() ?: 'GET';
+
+        $hydraOperation = $operation->getHydraContext() ?? [];
+        if ($operation->getDeprecationReason()) {
+            $hydraOperation['owl:deprecated'] = true;
+        }
+
+        $shortName = $operation->getShortName();
+        $inputMetadata = $operation->getInput() ?? [];
+        $outputMetadata = $operation->getOutput() ?? [];
+
+        $inputClass = \array_key_exists('class', $inputMetadata) ? $inputMetadata['class'] : false;
+        $outputClass = \array_key_exists('class', $outputMetadata) ? $outputMetadata['class'] : false;
+
+        if ('GET' === $method && $operation instanceof CollectionOperationInterface) {
+            $hydraOperation += [
+                '@type' => [$hydraPrefix.'Operation', 'schema:FindAction'],
+                $hydraPrefix.'description' => "Retrieves the collection of $shortName resources.",
+                'returns' => null === $outputClass ? 'owl:Nothing' : $hydraPrefix.'Collection',
+            ];
+        } elseif ('GET' === $method) {
+            $hydraOperation += [
+                '@type' => [$hydraPrefix.'Operation', 'schema:FindAction'],
+                $hydraPrefix.'description' => "Retrieves a $shortName resource.",
+                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
+            ];
+        } elseif ('PATCH' === $method) {
+            $hydraOperation += [
+                '@type' => $hydraPrefix.'Operation',
+                $hydraPrefix.'description' => "Updates the $shortName resource.",
+                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
+                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
+            ];
+
+            if (null !== $inputClass) {
+                $possibleValue = [];
+                foreach ($operation->getInputFormats() ?? [] as $mimeTypes) {
+                    foreach ($mimeTypes as $mimeType) {
+                        $possibleValue[] = $mimeType;
+                    }
+                }
+
+                $hydraOperation['expectsHeader'] = [['headerName' => 'Content-Type', 'possibleValue' => $possibleValue]];
+            }
+        } elseif ('POST' === $method) {
+            $hydraOperation += [
+                '@type' => [$hydraPrefix.'Operation', 'schema:CreateAction'],
+                $hydraPrefix.'description' => "Creates a $shortName resource.",
+                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
+                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
+            ];
+        } elseif ('PUT' === $method) {
+            $hydraOperation += [
+                '@type' => [$hydraPrefix.'Operation', 'schema:ReplaceAction'],
+                $hydraPrefix.'description' => "Replaces the $shortName resource.",
+                'returns' => null === $outputClass ? 'owl:Nothing' : $prefixedShortName,
+                'expects' => null === $inputClass ? 'owl:Nothing' : $prefixedShortName,
+            ];
+        } elseif ('DELETE' === $method) {
+            $hydraOperation += [
+                '@type' => [$hydraPrefix.'Operation', 'schema:DeleteAction'],
+                $hydraPrefix.'description' => "Deletes the $shortName resource.",
+                'returns' => 'owl:Nothing',
+            ];
+        }
+
+        $hydraOperation[$hydraPrefix.'method'] ??= $method;
+        $hydraOperation[$hydraPrefix.'title'] ??= strtolower($method).$shortName.($operation instanceof CollectionOperationInterface ? 'Collection' : '');
+
+        ksort($hydraOperation);
+
+        return $hydraOperation;
+    }
+}