Add Operation mutator

Author: loic425

src/Metadata/AsOperationMutator.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (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.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsOperationMutator
+{
+    public function __construct(
+        public readonly string $operationName,
+    ) {
+    }
+}

src/Metadata/OperationMutatorInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace ApiPlatform\Metadata;
+
+interface OperationMutatorInterface
+{
+    public function __invoke(Operation $operation): Operation;
+}

src/Metadata/Resource/Factory/CustomResourceMetadataCollectionFactory.php renamed to src/Metadata/Resource/Factory/MutatorResourceMetadataCollectionFactory.php

@@ -14,10 +14,15 @@
 namespace ApiPlatform\Metadata\Resource\Factory;
 
 use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
+use ApiPlatform\Metadata\ResourceMutatorInterface;
 use Psr\Container\ContainerInterface;
 
-final class CustomResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
+final class MutatorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
 {
+    /**
+     * @param ContainerInterface<ResourceMutatorInterface[]> $resourceMutators
+     * @param ResourceMetadataCollectionFactoryInterface|null $decorated
+     */
     public function __construct(
         private readonly ContainerInterface $resourceMutators,
         private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
@@ -34,8 +39,8 @@ public function create(string $resourceClass): ResourceMetadataCollection
         $newMetadataCollection = new ResourceMetadataCollection($resourceClass);
 
         foreach ($resourceMetadataCollection as $resource) {
-            foreach ($this->resourceMutators->get($resourceClass) as $mutators) {
-                $resource = $mutators($resource);
+            foreach ($this->resourceMutators->get($resourceClass) as $mutator) {
+                $resource = $mutator($resource);
             }
 
             $newMetadataCollection[] = $resource;

src/Metadata/ResourceMutatorInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace ApiPlatform\Metadata;
+
+interface ResourceMutatorInterface
+{
+    public function __invoke(ApiResource $resource): ApiResource;
+}

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -31,8 +31,11 @@
 use ApiPlatform\GraphQl\Resolver\QueryItemResolverInterface;
 use ApiPlatform\GraphQl\Type\Definition\TypeInterface as GraphQlTypeInterface;
 use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\AsOperationMutator;
 use ApiPlatform\Metadata\AsResourceMutator;
 use ApiPlatform\Metadata\FilterInterface;
+use ApiPlatform\Metadata\OperationMutatorInterface;
+use ApiPlatform\Metadata\ResourceMutatorInterface;
 use ApiPlatform\Metadata\UriVariableTransformerInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\OpenApi\Model\Tag;
@@ -186,13 +189,29 @@ public function load(array $configs, ContainerBuilder $container): void
                 ->addTag('container.excluded', ['source' => 'by #[ApiResource] attribute']);
         });
         $container->registerAttributeForAutoconfiguration(AsResourceMutator::class,
-            static function (ChildDefinition $definition, AsResourceMutator $attribute): void {
+            static function (ChildDefinition $definition, AsResourceMutator $attribute, \ReflectionClass $reflector): void {
+                if (!is_a($reflector->name, ResourceMutatorInterface::class, true)) {
+                    throw new RuntimeException(sprintf('Resource mutator "%s" should implement %s', $reflector->name, ResourceMutatorInterface::class));
+                }
+
                 $definition->addTag('api_platform.resource_mutator', [
                     'resourceClass' => $attribute->resourceClass,
                 ]);
             },
         );
 
+        $container->registerAttributeForAutoconfiguration(AsOperationMutator::class,
+            static function (ChildDefinition $definition, AsOperationMutator $attribute, \ReflectionClass $reflector): void {
+                if (!is_a($reflector->name, OperationMutatorInterface::class, true)) {
+                    throw new RuntimeException(sprintf('Operation mutator "%s" should implement %s', $reflector->name, OperationMutatorInterface::class));
+                }
+
+                $definition->addTag('api_platform.operation_mutator', [
+                    'operationName' => $attribute->operationName,
+                ]);
+            },
+        );
+
         if (!$container->has('api_platform.state.item_provider')) {
             $container->setAlias('api_platform.state.item_provider', 'api_platform.state_provider.object');
         }

src/Symfony/Bundle/Resources/config/metadata/resource.xml

@@ -30,9 +30,9 @@
             <argument type="service" id="service_container" on-invalid="null" />
         </service>
 
-        <service id="api_platform.metadata.resource.metadata_collection_factory.custom" class="ApiPlatform\Metadata\Resource\Factory\CustomResourceMetadataCollectionFactory" decorates="api_platform.metadata.resource.metadata_collection_factory" decoration-priority="800" public="false" >
+        <service id="api_platform.metadata.resource.metadata_collection_factory.mutator" class="ApiPlatform\Metadata\Resource\Factory\MutatorResourceMetadataCollectionFactory" decorates="api_platform.metadata.resource.metadata_collection_factory" decoration-priority="800" public="false" >
             <argument type="service" id="api_platform.metadata.mutator_collection.resource" />
-            <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory.custom.inner" />
+            <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory.mutator.inner" />
         </service>
 
         <service id="api_platform.metadata.resource.metadata_collection_factory.concerns" class="ApiPlatform\Metadata\Resource\Factory\ConcernsResourceMetadataCollectionFactory" decorates="api_platform.metadata.resource.metadata_collection_factory" decoration-priority="800" public="false">