Deprecates class and services

Author: lruozzi9

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.')
     ;
 };

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')
     ;
 

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')])
     ;

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)

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([

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)

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.')
     ;
 };

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)

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"/>

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
 {

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;

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)

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)

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 = [])

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 = [])

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(

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(

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(

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)

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)

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;

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)

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(

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;

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

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;

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(

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;

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';

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;

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)

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
 {
     /**

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)

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
 {
     /**