[Maintenance] Cleanup and usable string extraction to consts

Author: NoResponseMate

phpstan.neon

@@ -10,3 +10,4 @@ parameters:
 
     excludePaths:
         - '%currentWorkingDirectory%/src/DependencyInjection/Configuration.php'
+        - '%currentWorkingDirectory%/src/Serializer/ExportAwareItemNormalizer.php'

src/Controller/ExportAction.php

@@ -13,8 +13,6 @@
 
 namespace Sylius\ImportExport\Controller;
 
-use Sylius\Bundle\ResourceBundle\Controller\ParametersParserInterface;
-use Sylius\Component\Grid\Provider\GridProviderInterface;
 use Sylius\ImportExport\Messenger\Command\CreateExportProcess;
 use Sylius\ImportExport\Provider\Parameters\GridExportParametersProviderInterface;
 use Sylius\ImportExport\Provider\ResourceIds\ResourcesIdsProviderInterface;

src/DependencyInjection/Configuration.php

@@ -13,6 +13,7 @@
 
 namespace Sylius\ImportExport\DependencyInjection;
 
+use Sylius\ImportExport\Serializer\DefaultSerializationGroups;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
@@ -59,7 +60,7 @@ private function addExportConfiguration(ArrayNodeDefinition $node): void
                                 ->children()
                                     ->scalarNode('serialization_group')
                                         ->isRequired()
-                                        ->defaultValue('sylius_import_export.export')
+                                        ->defaultValue(DefaultSerializationGroups::EXPORT_GROUP)
                                     ->end()
                                     ->scalarNode('provider')
                                         ->defaultNull()

src/Provider/Parameters/GridExportParametersProvider.php

@@ -1,11 +1,21 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\ImportExport\Provider\Parameters;
 
 use Sylius\Bundle\ResourceBundle\Controller\ParametersParserInterface;
 use Sylius\Component\Grid\Provider\GridProviderInterface;
+use Sylius\ImportExport\Serializer\DefaultSerializationGroups;
 use Sylius\Resource\Metadata\MetadataInterface;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -24,7 +34,7 @@ public function getParameters(MetadataInterface $metadata, string $gridName, Req
         $gridConfiguration = $this->gridProvider->get($gridName);
 
         $resourceExportConfiguration = $this->resourceExportConfiguration[$metadata->getAlias()] ?? [];
-        $serializationGroup = $resourceExportConfiguration['serialization_group'] ?? 'sylius_import_export.export';
+        $serializationGroup = $resourceExportConfiguration['serialization_group'] ?? DefaultSerializationGroups::EXPORT_GROUP;
 
         $parameters = $this->parametersParser->parseRequestValues(
             $gridConfiguration->getDriverConfiguration(),

src/Provider/Parameters/GridExportParametersProviderInterface.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\ImportExport\Provider\Parameters;

src/Provider/ResourceData/GridResourceDataProvider.php

@@ -20,6 +20,8 @@
 use Sylius\Component\Grid\Provider\GridProviderInterface;
 use Sylius\ImportExport\Exception\ProviderException;
 use Sylius\ImportExport\Provider\ResourceIdentifierProviderInterface;
+use Sylius\ImportExport\Serializer\DefaultSerializationGroups;
+use Sylius\ImportExport\Serializer\ExportAwareItemNormalizer;
 use Sylius\Resource\Metadata\MetadataInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -55,9 +57,10 @@ public function getData(MetadataInterface $resource, string $gridCode, array $re
 
         $rawData = $dataSource->getQueryBuilder()->getQuery()->getResult();
 
+        /** @phpstan-ignore-next-line */
         return $this->serializer->normalize($rawData, context: [
-            'sylius_import_export.export' => true,
-            'groups' => array_merge($parameters['serialization_groups'] ?? [], ['sylius_import_export:export']),
+            ExportAwareItemNormalizer::EXPORT_CONTEXT_KEY => true,
+            'groups' => $parameters['serialization_groups'], [DefaultSerializationGroups::EXPORT_GROUP],
         ]);
     }
 }

src/Serializer/DefaultSerializationGroups.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\ImportExport\Serializer;
+
+final class DefaultSerializationGroups
+{
+    public const EXPORT_GROUP = 'sylius_import_export:export';
+}

src/Serializer/ExportAwareItemNormalizer.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\ImportExport\Serializer;
@@ -19,11 +28,14 @@
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
- * @internal Decorates the original to prevent generating iris for exportable items.
  * @see ItemNormalizer
+ *
+ * @internal Decorates the original to prevent generating iris for exportable items.
  */
 class ExportAwareItemNormalizer extends ItemNormalizer
 {
+    public const EXPORT_CONTEXT_KEY = 'sylius_import_export.export';
+
     public function __construct(
         PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory,
         PropertyMetadataFactoryInterface $propertyMetadataFactory,
@@ -57,7 +69,7 @@ public function __construct(
 
     public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
     {
-        if (isset($context['sylius_import_export.export'])) {
+        if (isset($context[self::EXPORT_CONTEXT_KEY])) {
             return false;
         }
 
@@ -73,9 +85,9 @@ public function supportsDenormalization(
         mixed $data,
         string $type,
         ?string $format = null,
-        array $context = []
+        array $context = [],
     ): bool {
-        if (isset($context['sylius_import_export.export'])) {
+        if (isset($context[self::EXPORT_CONTEXT_KEY])) {
             return false;
         }