chore: missing deprecations (#6480)

Author: soyuka

src/Action/NotExposedAction.php

@@ -18,6 +18,8 @@
 
 /**
  * An action which always returns HTTP 404 Not Found with an explanation for why the operation is not exposed.
+ *
+ * @deprecated use ApiPlatform\Symfony\Action\NotExposedAction
  */
 final class NotExposedAction
 {

src/Action/NotFoundAction.php

@@ -17,6 +17,8 @@
 
 /**
  * An action which always returns HTTP 404 Not Found. Useful for disabling an operation.
+ *
+ * @deprecated use ApiPlatform\Symfony\Action\NotFoundAction
  */
 final class NotFoundAction
 {

src/Action/PlaceholderAction.php

@@ -17,6 +17,8 @@
  * Placeholder returning the data passed in parameter.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Symfony\Action\PlaceholderAction
  */
 final class PlaceholderAction
 {

src/Elasticsearch/Metadata/Resource/Factory/ElasticsearchProviderResourceMetadataCollectionFactory.php

@@ -21,15 +21,17 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
-use ApiPlatform\Metadata\Util\Inflector;
 use Elasticsearch\Client;
 use Elasticsearch\Common\Exceptions\Missing404Exception;
 use Elasticsearch\Common\Exceptions\NoNodesAvailableException;
 
 final class ElasticsearchProviderResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
 {
-    public function __construct(private readonly ?Client $client, private readonly ResourceMetadataCollectionFactoryInterface $decorated, private readonly bool $triggerDeprecation = true, private readonly ?InflectorInterface $inflector = new Inflector()) // @phpstan-ignore-line
+    public function __construct(private readonly ?Client $client, private readonly ResourceMetadataCollectionFactoryInterface $decorated, private readonly bool $triggerDeprecation = true, private readonly ?InflectorInterface $inflector = null) // @phpstan-ignore-line
     {
+        if ($client) {
+            trigger_deprecation('api-platform/core', '4.0', sprintf('Using $client at "%s" is deprecated and the argument will be removed.', self::class));
+        }
     }
 
     /**

src/Exception/DeserializationException.php

@@ -20,6 +20,8 @@
  *
  * @author Samuel ROZE <[email protected]>
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated
  */
 class DeserializationException extends \Exception implements ExceptionInterface, SerializerExceptionInterface
 {

src/Exception/ErrorCodeSerializableInterface.php

@@ -15,6 +15,8 @@
 
 /**
  * An exception which has a serializable application-specific error code.
+ *
+ * @deprecated
  */
 interface ErrorCodeSerializableInterface
 {

src/Exception/ExceptionInterface.php

@@ -17,6 +17,8 @@
  * Base exception interface.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\ExceptionInterface
  */
 interface ExceptionInterface extends \Throwable
 {

src/Exception/InvalidArgumentException.php

@@ -17,6 +17,8 @@
  * Invalid argument exception.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\InvalidArgumentException
  */
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {

src/Exception/InvalidIdentifierException.php

@@ -17,6 +17,8 @@
  * Identifier is not valid exception.
  *
  * @author Antoine Bluchet <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\InvalidIdentifierException
  */
 class InvalidIdentifierException extends \Exception implements ExceptionInterface
 {

src/Exception/InvalidResourceException.php

@@ -17,6 +17,8 @@
  * Invalid resource exception.
  *
  * @author Paul Le Corre <[email protected]>
+ *
+ * @deprecated
  */
 class InvalidResourceException extends \Exception implements ExceptionInterface
 {

src/Exception/InvalidUriVariableException.php

@@ -17,6 +17,8 @@
  * Identifier is not valid exception.
  *
  * @author Antoine Bluchet <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\InvalidUriVariableException
  */
 class InvalidUriVariableException extends \Exception implements ExceptionInterface
 {

src/Exception/InvalidValueException.php

@@ -13,6 +13,9 @@
 
 namespace ApiPlatform\Exception;
 
+/**
+ * @deprecated
+ */
 class InvalidValueException extends InvalidArgumentException
 {
 }

src/Exception/ItemNotFoundException.php

@@ -17,6 +17,8 @@
  * Item not found exception.
  *
  * @author Amrouche Hamza <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\ItemNotFoundException
  */
 class ItemNotFoundException extends InvalidArgumentException
 {

src/Exception/NotExposedHttpException.php

@@ -17,6 +17,8 @@
 
 /**
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\NotExposedHttpException
  */
 class NotExposedHttpException extends NotFoundHttpException
 {

src/Exception/OperationNotFoundException.php

@@ -15,6 +15,8 @@
 
 /**
  * Operation not found exception.
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\OperationNotFoundException
  */
 class OperationNotFoundException extends \InvalidArgumentException implements ExceptionInterface
 {

src/Exception/PropertyNotFoundException.php

@@ -17,6 +17,8 @@
  * Property not found exception.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\PropertyNotFoundException
  */
 class PropertyNotFoundException extends \Exception implements ExceptionInterface
 {

src/Exception/ResourceClassNotFoundException.php

@@ -17,6 +17,8 @@
  * Resource class not found exception.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\ResourceClassNotFoundException
  */
 class ResourceClassNotFoundException extends \Exception implements ExceptionInterface
 {

src/Exception/ResourceClassNotSupportedException.php

@@ -16,6 +16,8 @@
 /**
  * Resource class not supported exception.
  *
+ * @deprecated
+ *
  * @author Kévin Dunglas <[email protected]>
  */
 class ResourceClassNotSupportedException extends \Exception implements ExceptionInterface

src/Exception/RuntimeException.php

@@ -17,6 +17,8 @@
  * Runtime exception.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated use ApiPlatform\Metadata\Exception\RuntimeException
  */
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {

src/GraphQl/Resolver/Factory/CollectionResolverFactory.php

@@ -32,6 +32,8 @@
  * @author Alan Poulain <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 final class CollectionResolverFactory implements ResolverFactoryInterface
 {

src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php

@@ -35,6 +35,8 @@
  *
  * @author Alan Poulain <[email protected]>
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 final class ItemMutationResolverFactory implements ResolverFactoryInterface
 {

src/GraphQl/Resolver/Factory/ItemResolverFactory.php

@@ -32,6 +32,8 @@
  * @author Alan Poulain <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 final class ItemResolverFactory implements ResolverFactoryInterface
 {

src/GraphQl/Resolver/Factory/ItemSubscriptionResolverFactory.php

@@ -28,6 +28,8 @@
  * Creates a function resolving a GraphQL subscription of an item.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class ItemSubscriptionResolverFactory implements ResolverFactoryInterface
 {

src/GraphQl/Resolver/Stage/DeserializeStage.php

@@ -23,6 +23,8 @@
  * Deserialize stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class DeserializeStage implements DeserializeStageInterface
 {

src/GraphQl/Resolver/Stage/DeserializeStageInterface.php

@@ -19,6 +19,8 @@
  * Deserialize stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 interface DeserializeStageInterface
 {

src/GraphQl/Resolver/Stage/ReadStage.php

@@ -27,6 +27,8 @@
  * Read stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class ReadStage implements ReadStageInterface
 {

src/GraphQl/Resolver/Stage/ReadStageInterface.php

@@ -19,6 +19,8 @@
  * Read stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 interface ReadStageInterface
 {

src/GraphQl/Resolver/Stage/SecurityPostDenormalizeStage.php

@@ -22,6 +22,8 @@
  * Security post denormalize stage of GraphQL resolvers.
  *
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 final class SecurityPostDenormalizeStage implements SecurityPostDenormalizeStageInterface
 {

src/GraphQl/Resolver/Stage/SecurityPostDenormalizeStageInterface.php

@@ -20,6 +20,8 @@
  * Security post deserialization stage of GraphQL resolvers.
  *
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 interface SecurityPostDenormalizeStageInterface
 {

src/GraphQl/Resolver/Stage/SecurityPostValidationStageInterface.php

@@ -21,6 +21,8 @@
  *
  * @author Vincent Chalamon <[email protected]>
  * @author Grégoire Pineau <[email protected]>
+ *
+ * @deprecated
  */
 interface SecurityPostValidationStageInterface
 {

src/GraphQl/Resolver/Stage/SecurityStage.php

@@ -22,6 +22,8 @@
  * Security stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class SecurityStage implements SecurityStageInterface
 {

src/GraphQl/Resolver/Stage/SecurityStageInterface.php

@@ -21,6 +21,8 @@
  *
  * @author Alan Poulain <[email protected]>
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated
  */
 interface SecurityStageInterface
 {

src/GraphQl/Resolver/Stage/SerializeStage.php

@@ -30,6 +30,8 @@
  * Serialize stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class SerializeStage implements SerializeStageInterface
 {

src/GraphQl/Resolver/Stage/SerializeStageInterface.php

@@ -19,6 +19,8 @@
  * Serialize stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 interface SerializeStageInterface
 {

src/GraphQl/Resolver/Stage/ValidateStage.php

@@ -20,6 +20,8 @@
  * Validate stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class ValidateStage implements ValidateStageInterface
 {

src/GraphQl/Resolver/Stage/ValidateStageInterface.php

@@ -20,6 +20,8 @@
  * Validate stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 interface ValidateStageInterface
 {

src/GraphQl/Resolver/Stage/WriteStage.php

@@ -21,6 +21,8 @@
  * Write stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 final class WriteStage implements WriteStageInterface
 {

src/GraphQl/Resolver/Stage/WriteStageInterface.php

@@ -19,6 +19,8 @@
  * Write stage of GraphQL resolvers.
  *
  * @author Alan Poulain <[email protected]>
+ *
+ * @deprecated
  */
 interface WriteStageInterface
 {

src/GraphQl/Subscription/SubscriptionManager.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\GraphQl\Subscription;
 
+use ApiPlatform\GraphQl\Resolver\Stage\SerializeStage;
 use ApiPlatform\GraphQl\Resolver\Stage\SerializeStageInterface;
 use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
 use ApiPlatform\Metadata\GraphQl\Operation;
@@ -37,8 +38,11 @@ final class SubscriptionManager implements OperationAwareSubscriptionManagerInte
     use ResourceClassInfoTrait;
     use SortTrait;
 
-    public function __construct(private readonly CacheItemPoolInterface $subscriptionsCache, private readonly SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, private readonly ?SerializeStageInterface $serializeStage, private readonly IriConverterInterface $iriConverter, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, private readonly ?ProcessorInterface $normalizeProcessor = null)
+    public function __construct(private readonly CacheItemPoolInterface $subscriptionsCache, private readonly SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, private readonly SerializeStageInterface|ProcessorInterface|null $serializeStage = null, private readonly ?IriConverterInterface $iriConverter = null, private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
     {
+        if (!$serializeStage instanceof ProcessorInterface) {
+            trigger_deprecation('api-platform/core', '4.0', sprintf('Using an instanceof "%s" is deprecated, use "%s" instead.', SerializeStageInterface::class, ProcessorInterface::class));
+        }
     }
 
     public function retrieveSubscriptionId(array $context, ?array $result, ?Operation $operation = null): ?string
@@ -85,9 +89,9 @@ public function getPushPayloads(object $object): array
             $resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];
             /** @var Operation */
             $operation = (new Subscription())->withName('update_subscription')->withShortName($shortName);
-            if ($this->normalizeProcessor) {
-                $data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);
-            } elseif ($this->serializeStage) {
+            if ($this->serializeStage instanceof ProcessorInterface) {
+                $data = $this->serializeStage->process($object, $operation, [], $resolverContext);
+            } elseif ($this->serializeStage instanceof SerializeStage) {
                 $data = ($this->serializeStage)($object, $resourceClass, $operation, $resolverContext);
             } else {
                 throw new \LogicException();