Deprecates class and services

lruozzi9 · lruozzi9 · commit 763ae6dbde41 · 2024-10-08T10:41:33.000+02:00
diff --git a/config/services/checker.php b/config/services/checker.php
@@ -14,5 +14,6 @@
             service('webgriffe_sylius_clerk.provider.public_api_key'),
             service('webgriffe_sylius_clerk.provider.private_api_key'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 };
diff --git a/config/services/command.php b/config/services/command.php
@@ -18,6 +18,7 @@
             '$router' => service('router'),
             '$logger' => service('monolog.logger'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
         ->tag('console.command')
     ;
 
diff --git a/config/services/controller.php b/config/services/controller.php
@@ -21,6 +21,7 @@
             service('webgriffe_sylius_clerk.provider.private_api_key'),
             service('webgriffe_sylius_clerk.checker.channel_enabled'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
         ->tag('controller.service_arguments')
         ->call('setContainer', [service('service_container')])
     ;
diff --git a/config/services/generator.php b/config/services/generator.php
@@ -24,6 +24,7 @@
             service(PageResolver::class),
             service('serializer'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set('webgriffe_sylius_clerk_plugin.feed_generator.products', ResourceFeedGenerator::class)
diff --git a/config/services/provider.php b/config/services/provider.php
@@ -13,9 +13,13 @@
 return static function (ContainerConfigurator $containerConfigurator) {
     $services = $containerConfigurator->services();
 
-    $services->set('webgriffe_sylius_clerk.provider.private_api_key', PrivateApiKeyProvider::class);
+    $services->set('webgriffe_sylius_clerk.provider.private_api_key', PrivateApiKeyProvider::class)
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
+    ;
 
-    $services->set('webgriffe_sylius_clerk.provider.public_api_key', PublicApiKeyProvider::class);
+    $services->set('webgriffe_sylius_clerk.provider.public_api_key', PublicApiKeyProvider::class)
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
+    ;
 
     $services->set('webgriffe_sylius_clerk_plugin.provider.products', QueryBuilderResourceProvider::class)
         ->args([
diff --git a/config/services/query_builder.php b/config/services/query_builder.php
@@ -20,24 +20,28 @@
         ->args([
             service('sylius.repository.product'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set(TaxonsQueryBuilderFactory::class)
         ->args([
             service('sylius.repository.taxon'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set(OrdersQueryBuilderFactory::class)
         ->args([
             service('sylius.repository.order'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set(CustomersQueryBuilderFactory::class)
         ->args([
             service('sylius.repository.customer'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set('webgriffe_sylius_clerk_plugin.query_builder.products', ProductsQueryBuilder::class)
diff --git a/config/services/resolver.php b/config/services/resolver.php
@@ -11,11 +11,14 @@
 return static function (ContainerConfigurator $containerConfigurator) {
     $services = $containerConfigurator->services();
 
-    $services->set(PageResolver::class);
+    $services->set(PageResolver::class)
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
+    ;
 
     $services->set(OrderResolver::class)
         ->args([
             service(OrdersQueryBuilderFactory::class),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 };
diff --git a/config/services/serializer.php b/config/services/serializer.php
@@ -23,6 +23,7 @@
             service('router'),
             service('liip_imagine.service.filter'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
         ->tag('serializer.normalizer', ['priority' => 120])
     ;
 
@@ -32,17 +33,20 @@
             service('router'),
             service('sylius.repository.taxon'),
         ])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
         ->tag('serializer.normalizer', ['priority' => 120])
     ;
 
     $services->set(OrderNormalizer::class)
         ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'Service "%service_id%" is deprecated and will be removed in the next major version.')
         ->tag('serializer.normalizer', ['priority' => 120])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set(CustomerNormalizer::class)
         ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'Service "%service_id%" is deprecated and will be removed in the next major version.')
         ->tag('serializer.normalizer', ['priority' => 120])
+        ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')
     ;
 
     $services->set('webgriffe_sylius_clerk_plugin.normalizer.product', V2ProductNormalizer::class)
diff --git a/psalm.xml b/psalm.xml
@@ -14,6 +14,16 @@
         </ignoreFiles>
     </projectFiles>
     <issueHandlers>
+        <DeprecatedInterface>
+            <errorLevel type="suppress">
+                <directory name="src/"/>
+            </errorLevel>
+        </DeprecatedInterface>
+        <DeprecatedClass>
+            <errorLevel type="suppress">
+                <directory name="src/"/>
+            </errorLevel>
+        </DeprecatedClass>
         <PropertyNotSetInConstructor>
             <errorLevel type="suppress">
                 <referencedProperty name="Symfony\Bundle\FrameworkBundle\Controller\AbstractController::$container"/>
diff --git a/src/Command/FeedGeneratorCommand.php b/src/Command/FeedGeneratorCommand.php
@@ -18,7 +18,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * @deprecated
+ * @deprecated This command is deprecated and will be removed in the next major version.
  */
 final class FeedGeneratorCommand extends Command
 {
diff --git a/src/Controller/FeedController.php b/src/Controller/FeedController.php
@@ -16,6 +16,9 @@
 use Webgriffe\SyliusClerkPlugin\Service\FeedGeneratorInterface;
 use Webgriffe\SyliusClerkPlugin\Service\PrivateApiKeyProviderInterface;
 
+/**
+ * @deprecated This controller is deprecated and will be removed in the next major version.
+ */
 final class FeedController extends AbstractController
 {
     private ?ChannelApiKeyCheckerInterface $channelApiKeyChecker;
diff --git a/src/Exception/PrivateApiKeyNotFoundForChannelException.php b/src/Exception/PrivateApiKeyNotFoundForChannelException.php
@@ -6,6 +6,9 @@
 
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated Use \Webgriffe\SyliusClerkPlugin\Provider\Exception\ChannelApiKeysNotProvidedException instead
+ */
 final class PrivateApiKeyNotFoundForChannelException extends \RuntimeException
 {
     public function __construct(ChannelInterface $channel)
diff --git a/src/Exception/PublicApiKeyNotFoundForChannelException.php b/src/Exception/PublicApiKeyNotFoundForChannelException.php
@@ -6,6 +6,9 @@
 
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated Use \Webgriffe\SyliusClerkPlugin\Provider\Exception\ChannelApiKeysNotProvidedException instead
+ */
 final class PublicApiKeyNotFoundForChannelException extends \RuntimeException
 {
     public function __construct(ChannelInterface $channel)
diff --git a/src/Normalizer/CustomerNormalizer.php b/src/Normalizer/CustomerNormalizer.php
@@ -9,6 +9,9 @@
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Webgriffe\SyliusClerkPlugin\Service\FeedGenerator;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use the new Clerk feed v2 normalizer instead.
+ */
 final class CustomerNormalizer implements NormalizerInterface
 {
     public function normalize($object, string $format = null, array $context = [])
diff --git a/src/Normalizer/OrderNormalizer.php b/src/Normalizer/OrderNormalizer.php
@@ -10,6 +10,9 @@
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Webgriffe\SyliusClerkPlugin\Service\FeedGenerator;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use the new Clerk feed v2 normalizer instead.
+ */
 final class OrderNormalizer implements NormalizerInterface
 {
     public function normalize($object, string $format = null, array $context = [])
diff --git a/src/Normalizer/ProductNormalizer.php b/src/Normalizer/ProductNormalizer.php
@@ -18,6 +18,9 @@
 use Webgriffe\SyliusClerkPlugin\Service\FeedGenerator;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use the new Clerk feed v2 normalizer instead.
+ */
 final class ProductNormalizer implements NormalizerInterface
 {
     public function __construct(
diff --git a/src/Normalizer/TaxonNormalizer.php b/src/Normalizer/TaxonNormalizer.php
@@ -14,6 +14,9 @@
 use Webgriffe\SyliusClerkPlugin\Service\FeedGenerator;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use the new Clerk feed v2 normalizer instead.
+ */
 final class TaxonNormalizer implements NormalizerInterface
 {
     public function __construct(
diff --git a/src/QueryBuilder/CustomersQueryBuilderFactory.php b/src/QueryBuilder/CustomersQueryBuilderFactory.php
@@ -10,6 +10,9 @@
 use Sylius\Component\Core\Repository\CustomerRepositoryInterface;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use query builder event on v2 feed generation instead.
+ */
 final class CustomersQueryBuilderFactory implements QueryBuilderFactoryInterface
 {
     public function __construct(
diff --git a/src/QueryBuilder/OrdersQueryBuilderFactory.php b/src/QueryBuilder/OrdersQueryBuilderFactory.php
@@ -10,6 +10,9 @@
 use Sylius\Component\Core\Repository\OrderRepositoryInterface;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use query builder event on v2 feed generation instead.
+ */
 final class OrdersQueryBuilderFactory implements QueryBuilderFactoryInterface
 {
     public function __construct(private OrderRepositoryInterface $orderRepository)
diff --git a/src/QueryBuilder/ProductsQueryBuilderFactory.php b/src/QueryBuilder/ProductsQueryBuilderFactory.php
@@ -10,6 +10,9 @@
 use Sylius\Component\Locale\Model\LocaleInterface;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use query builder event on v2 feed generation instead.
+ */
 final class ProductsQueryBuilderFactory implements QueryBuilderFactoryInterface
 {
     public function __construct(private ProductRepositoryInterface $productRepository)
diff --git a/src/QueryBuilder/QueryBuilderFactoryInterface.php b/src/QueryBuilder/QueryBuilderFactoryInterface.php
@@ -7,6 +7,9 @@
 use Doctrine\ORM\QueryBuilder;
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use query builder event on v2 feed generation instead.
+ */
 interface QueryBuilderFactoryInterface
 {
     public function createQueryBuilder(ChannelInterface $channel): QueryBuilder;
diff --git a/src/QueryBuilder/TaxonsQueryBuilderFactory.php b/src/QueryBuilder/TaxonsQueryBuilderFactory.php
@@ -8,6 +8,9 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Taxonomy\Repository\TaxonRepositoryInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use query builder event on v2 feed generation instead.
+ */
 final class TaxonsQueryBuilderFactory implements QueryBuilderFactoryInterface
 {
     public function __construct(private TaxonRepositoryInterface $taxonRepository)
diff --git a/src/Resolver/OrderResolver.php b/src/Resolver/OrderResolver.php
@@ -8,6 +8,9 @@
 use Webgriffe\SyliusClerkPlugin\QueryBuilder\QueryBuilderFactoryInterface;
 use Webmozart\Assert\Assert;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use resource provider on v2 feed generation instead.
+ */
 final class OrderResolver implements OrderResolverInterface
 {
     public function __construct(
diff --git a/src/Resolver/OrderResolverInterface.php b/src/Resolver/OrderResolverInterface.php
@@ -6,6 +6,9 @@
 
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use resource provider on v2 feed generation instead.
+ */
 interface OrderResolverInterface
 {
     public function createOrdersList(ChannelInterface $channel): array;
diff --git a/src/Resolver/PageResolver.php b/src/Resolver/PageResolver.php
@@ -4,6 +4,9 @@
 
 namespace Webgriffe\SyliusClerkPlugin\Resolver;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use resource provider on v2 feed generation instead.
+ */
 final class PageResolver implements PageResolverInterface
 {
     public function createPageList(): array
diff --git a/src/Resolver/PageResolverInterface.php b/src/Resolver/PageResolverInterface.php
@@ -4,6 +4,9 @@
 
 namespace Webgriffe\SyliusClerkPlugin\Resolver;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version. Use resource provider on v2 feed generation instead.
+ */
 interface PageResolverInterface
 {
     public function createPageList(): array;
diff --git a/src/Service/ChannelApiKeyChecker.php b/src/Service/ChannelApiKeyChecker.php
@@ -8,6 +8,9 @@
 use Webgriffe\SyliusClerkPlugin\Exception\PrivateApiKeyNotFoundForChannelException;
 use Webgriffe\SyliusClerkPlugin\Exception\PublicApiKeyNotFoundForChannelException;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 final class ChannelApiKeyChecker implements ChannelApiKeyCheckerInterface
 {
     public function __construct(
diff --git a/src/Service/ChannelApiKeyCheckerInterface.php b/src/Service/ChannelApiKeyCheckerInterface.php
@@ -6,6 +6,9 @@
 
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 interface ChannelApiKeyCheckerInterface
 {
     public function check(ChannelInterface $channel): bool;
diff --git a/src/Service/FeedGenerator.php b/src/Service/FeedGenerator.php
@@ -15,6 +15,9 @@
 use Webgriffe\SyliusClerkPlugin\Resolver\OrderResolverInterface;
 use Webgriffe\SyliusClerkPlugin\Resolver\PageResolverInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 final class FeedGenerator implements FeedGeneratorInterface
 {
     public const NORMALIZATION_FORMAT = 'clerk_array';
diff --git a/src/Service/FeedGeneratorInterface.php b/src/Service/FeedGeneratorInterface.php
@@ -6,6 +6,9 @@
 
 use Sylius\Component\Core\Model\ChannelInterface;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 interface FeedGeneratorInterface
 {
     public function generate(ChannelInterface $channel): string;
diff --git a/src/Service/PrivateApiKeyProvider.php b/src/Service/PrivateApiKeyProvider.php
@@ -7,6 +7,9 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Webgriffe\SyliusClerkPlugin\Exception\PrivateApiKeyNotFoundForChannelException;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 final class PrivateApiKeyProvider implements PrivateApiKeyProviderInterface
 {
     public function __construct(private array $clerkStores)
diff --git a/src/Service/PrivateApiKeyProviderInterface.php b/src/Service/PrivateApiKeyProviderInterface.php
@@ -7,6 +7,9 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Webgriffe\SyliusClerkPlugin\Exception\PrivateApiKeyNotFoundForChannelException;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 interface PrivateApiKeyProviderInterface
 {
     /**
diff --git a/src/Service/PublicApiKeyProvider.php b/src/Service/PublicApiKeyProvider.php
@@ -7,6 +7,9 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Webgriffe\SyliusClerkPlugin\Exception\PublicApiKeyNotFoundForChannelException;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 final class PublicApiKeyProvider implements PublicApiKeyProviderInterface
 {
     public function __construct(private array $clerkStores)
diff --git a/src/Service/PublicApiKeyProviderInterface.php b/src/Service/PublicApiKeyProviderInterface.php
@@ -7,6 +7,9 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Webgriffe\SyliusClerkPlugin\Exception\PublicApiKeyNotFoundForChannelException;
 
+/**
+ * @deprecated This class is deprecated and will be removed in the next major version.
+ */
 interface PublicApiKeyProviderInterface
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,6 @@`
`14`	`14`	`service('webgriffe_sylius_clerk.provider.public_api_key'),`
`15`	`15`	`service('webgriffe_sylius_clerk.provider.private_api_key'),`
`16`	`16`	`])`
	`17`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`17`	`18`	`;`
`18`	`19`	`};`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`'$router' => service('router'),`
`19`	`19`	`'$logger' => service('monolog.logger'),`
`20`	`20`	`])`
	`21`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`21`	`22`	`->tag('console.command')`
`22`	`23`	`;`
`23`	`24`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`service('webgriffe_sylius_clerk.provider.private_api_key'),`
`22`	`22`	`service('webgriffe_sylius_clerk.checker.channel_enabled'),`
`23`	`23`	`])`
	`24`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`24`	`25`	`->tag('controller.service_arguments')`
`25`	`26`	`->call('setContainer', [service('service_container')])`
`26`	`27`	`;`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`service(PageResolver::class),`
`25`	`25`	`service('serializer'),`
`26`	`26`	`])`
	`27`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`27`	`28`	`;`
`28`	`29`
`29`	`30`	`$services->set('webgriffe_sylius_clerk_plugin.feed_generator.products', ResourceFeedGenerator::class)`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`service('router'),`
`24`	`24`	`service('liip_imagine.service.filter'),`
`25`	`25`	`])`
	`26`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`26`	`27`	`->tag('serializer.normalizer', ['priority' => 120])`
`27`	`28`	`;`
`28`	`29`
`@@ -32,17 +33,20 @@`
`32`	`33`	`service('router'),`
`33`	`34`	`service('sylius.repository.taxon'),`
`34`	`35`	`])`
	`36`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`35`	`37`	`->tag('serializer.normalizer', ['priority' => 120])`
`36`	`38`	`;`
`37`	`39`
`38`	`40`	`$services->set(OrderNormalizer::class)`
`39`	`41`	`->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'Service "%service_id%" is deprecated and will be removed in the next major version.')`
`40`	`42`	`->tag('serializer.normalizer', ['priority' => 120])`
	`43`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`41`	`44`	`;`
`42`	`45`
`43`	`46`	`$services->set(CustomerNormalizer::class)`
`44`	`47`	`->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'Service "%service_id%" is deprecated and will be removed in the next major version.')`
`45`	`48`	`->tag('serializer.normalizer', ['priority' => 120])`
	`49`	`+ ->deprecate('webgriffe/sylius-clerk-plugin', '3.0', 'The "%service_id%" service is deprecated and will be removed in 4.0.')`
`46`	`50`	`;`
`47`	`51`
`48`	`52`	`$services->set('webgriffe_sylius_clerk_plugin.normalizer.product', V2ProductNormalizer::class)`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`use Webmozart\Assert\Assert;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * @deprecated`
	`21`	`+ * @deprecated This command is deprecated and will be removed in the next major version.`
`22`	`22`	`*/`
`23`	`23`	`final class FeedGeneratorCommand extends Command`
`24`	`24`	`{`