Add configuration and improve section resolving

NoResponseMate · NoResponseMate · commit 0d6c2aafcfee · 2025-07-02T09:04:04.000+02:00
diff --git a/config/services/grid.xml b/config/services/grid.xml
@@ -5,28 +5,10 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"
 >
-    <parameters>
-        <!--        Temp parameters, should go through config tree -->
-        <parameter key="sylius_import_export.grid.export.allowed_sections" type="collection">
-            <parameter>admin</parameter>
-        </parameter>
-        <parameter key="sylius_import_export.grid.export.allowed_resources" type="collection">
-            <parameter>sylius.product</parameter>
-            <parameter>sylius.payment</parameter>
-            <parameter>sylius.shipment</parameter>
-            <parameter>sylius.order</parameter>
-            <parameter>sylius.customer</parameter>
-            <parameter>sylius_grid_import_export.process</parameter>
-        </parameter>
-        <!--        -->
-    </parameters>
-
     <services>
         <service id="sylius_import_export.grid.checker.exportable" class="Sylius\GridImportExport\Grid\Checker\ExportableChecker">
-            <argument type="service" id="request_stack" />
             <argument type="service" id="sylius.resource_registry" />
-            <argument>%sylius_import_export.grid.export.allowed_sections%</argument>
-            <argument>%sylius_import_export.grid.export.allowed_resources%</argument>
+            <argument>%sylius_import_export.export.resources%</argument>
         </service>
 
         <service
@@ -39,6 +21,8 @@
         </service>
 
         <service id="sylius_import_export.grid.listener.admin.export_action" class="Sylius\GridImportExport\Grid\Listener\ExportActionAdminGridListener">
+            <argument type="service" id="request_stack" />
+            <argument type="service" id="sylius.section_resolver.uri_based" on-invalid="null" />
             <argument type="service" id="sylius_import_export.grid.checker.exportable" />
 
             <tag name="kernel.event_listener" event="sylius.grid.common" method="addExportActions" />
diff --git a/phpstan.neon b/phpstan.neon
@@ -7,3 +7,6 @@ parameters:
     ignoreErrors:
         - identifier: missingType.generics
         - identifier: missingType.iterableValue
+
+    excludePaths:
+        - '%currentWorkingDirectory%/src/DependencyInjection/Configuration.php'
diff --git a/src/Controller/ExportAction.php b/src/Controller/ExportAction.php
@@ -19,6 +19,7 @@
 use Sylius\GridImportExport\Provider\ResourceIds\ResourcesIdsProviderInterface;
 use Sylius\Resource\Metadata\RegistryInterface;
 use Symfony\Component\Form\FormFactoryInterface;
+use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -0,0 +1,75 @@
+<?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\GridImportExport\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+final class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        $treeBuilder = new TreeBuilder('sylius_grid_import_export');
+
+        /** @var ArrayNodeDefinition $rootNode */
+        $rootNode = $treeBuilder->getRootNode();
+
+        $this->addExportConfiguration($rootNode);
+
+        return $treeBuilder;
+    }
+
+    private function addExportConfiguration(ArrayNodeDefinition $node): void
+    {
+        $node
+            ->children()
+                ->arrayNode('export')
+                    ->isRequired()
+                    ->children()
+                        ->scalarNode('default_provider')
+                            ->defaultValue('orm')
+                            ->cannotBeEmpty()
+                        ->end()
+                        ->scalarNode('default_section')
+                            ->defaultValue('admin')
+                            ->cannotBeEmpty()
+                        ->end()
+                        ->arrayNode('resources')
+                            ->useAttributeAsKey('name')
+                            ->normalizeKeys(false)
+                            ->arrayPrototype()
+                                ->beforeNormalization()
+                                    ->ifNull()
+                                    ->then(function () {
+                                        return [];
+                                    })
+                                ->end()
+                                ->children()
+                                    ->scalarNode('provider')
+                                        ->defaultNull()
+                                    ->end()
+                                    ->arrayNode('sections')
+                                        ->scalarPrototype()->end()
+                                        ->defaultValue([])
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end() // resources
+                    ->end()
+                ->end() // export
+            ->end()
+        ;
+    }
+}
diff --git a/src/DependencyInjection/SyliusGridImportExportExtension.php b/src/DependencyInjection/SyliusGridImportExportExtension.php
@@ -22,7 +22,29 @@ final class SyliusGridImportExportExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
+        $configuration = $this->processConfiguration(new Configuration(), $configs);
+
+        $this->processExportConfig($container, $configuration);
+
         $loader = new XmlFileLoader($container, new FileLocator(dirname(__DIR__, 2) . '/config/'));
         $loader->load('services.xml');
     }
+
+    private function processExportConfig(ContainerBuilder $container, array &$config): void
+    {
+        $defaultProvider = $config['export']['default_provider'];
+        $defaultSection = $config['export']['default_section'];
+
+        foreach ($config['export']['resources'] as $name => &$resource) {
+            if (null === $resource['provider']) {
+                $resource['provider'] = $defaultProvider;
+            }
+            if ([] === $resource['sections']) {
+                $resource['sections'][] = $defaultSection;
+            }
+        }
+
+        $container->setParameter('sylius_import_export.export.default_provider', $defaultProvider);
+        $container->setParameter('sylius_import_export.export.resources', $config['export']['resources']);
+    }
 }
diff --git a/src/Grid/Checker/ExportableChecker.php b/src/Grid/Checker/ExportableChecker.php
@@ -15,46 +15,40 @@
 
 use Sylius\Component\Grid\Definition\Grid;
 use Sylius\Resource\Metadata\RegistryInterface;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\RequestStack;
 
-final class ExportableChecker implements ExportableCheckerInterface
+final readonly class ExportableChecker implements ExportableCheckerInterface
 {
-    /**
-     * @param array<array-key, string> $allowedSections
-     * @param array<array-key, string> $allowedResources
-     */
+    /** @param array<string, array{provider: string, sections: string[]}> $exportResourcesConfig */
     public function __construct(
-        private RequestStack $requestStack,
         private RegistryInterface $resourceRegistry,
-        private array $allowedSections,
-        private array $allowedResources,
+        private array $exportResourcesConfig,
     ) {
     }
 
-    public function canBeExported(Grid $grid): bool
+    public function canBeExported(Grid $grid, object|string|null $section): bool
     {
         $resourceClass = $grid->getDriverConfiguration()['class'] ?? null;
         if (null === $resourceClass) {
             return false;
         }
 
-        $request = $this->requestStack->getMainRequest();
-        if (!$request instanceof Request) {
-            return false;
+        if (null === $section) {
+            return true;
         }
 
-        if (!$request->attributes->has('_sylius')) {
-            return false;
-        }
+        $resourceAlias = $this->resourceRegistry->getByClass($resourceClass)->getAlias();
 
-        $syliusAttributes = $request->attributes->all()['_sylius'];
-        if (!in_array($syliusAttributes['section'] ?? null, $this->allowedSections)) {
+        $resourceConfig = $this->exportResourcesConfig[$resourceAlias] ?? false;
+        if (false === $resourceConfig) {
             return false;
         }
 
-        $resourceMetadata = $this->resourceRegistry->getByClass($resourceClass);
+        foreach ($resourceConfig['sections'] as $configSection) {
+            if (is_a($section, $configSection, true) || $section === $configSection) {
+                return true;
+            }
+        }
 
-        return in_array($resourceMetadata->getAlias(), $this->allowedResources);
+        return false;
     }
 }
diff --git a/src/Grid/Checker/ExportableCheckerInterface.php b/src/Grid/Checker/ExportableCheckerInterface.php
@@ -17,5 +17,5 @@
 
 interface ExportableCheckerInterface
 {
-    public function canBeExported(Grid $grid): bool;
+    public function canBeExported(Grid $grid, object|string|null $section): bool;
 }
diff --git a/src/Grid/Listener/ExportActionAdminGridListener.php b/src/Grid/Listener/ExportActionAdminGridListener.php
@@ -13,19 +13,23 @@
 
 namespace Sylius\GridImportExport\Grid\Listener;
 
+use Sylius\Bundle\CoreBundle\SectionResolver\SectionProviderInterface;
 use Sylius\Bundle\GridBundle\Builder\ActionGroup\ActionGroupInterface;
 use Sylius\Bundle\GridBundle\Doctrine\ORM\Driver as ORMDriver;
 use Sylius\Component\Grid\Definition\Action;
 use Sylius\Component\Grid\Definition\ActionGroup;
 use Sylius\Component\Grid\Definition\Grid;
 use Sylius\Component\Grid\Event\GridDefinitionConverterEvent;
 use Sylius\GridImportExport\Grid\Checker\ExportableCheckerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 final readonly class ExportActionAdminGridListener
 {
     private const EXPORT_ACTION_NAME = 'export';
 
     public function __construct(
+        private RequestStack $requestStack,
+        private ?SectionProviderInterface $sectionProvider,
         private ExportableCheckerInterface $exportableChecker,
     ) {
     }
@@ -37,10 +41,12 @@ public function addExportActions(GridDefinitionConverterEvent $event): void
             return;
         }
 
-        if (!$this->exportableChecker->canBeExported($grid)) {
+        $section = $this->sectionProvider?->getSection() ?? $this->getRouteSection();
+        if ($this->exportableChecker->canBeExported($grid, $section)) {
             return;
         }
 
+        // Introduce config for each case, default both
         $this->addInActionGroup($grid, ActionGroupInterface::MAIN_GROUP);
         $this->addInActionGroup($grid, ActionGroupInterface::BULK_GROUP);
     }
@@ -60,4 +66,14 @@ private function addInActionGroup(Grid $grid, string $groupName): void
 
         $actionGroup->addAction($action);
     }
+
+    private function getRouteSection(): ?string
+    {
+        $request = $this->requestStack->getMainRequest();
+        if (null === $request) {
+            return null;
+        }
+
+        return $request->attributes->all()['_sylius']['section'] ?? null;
+    }
 }
diff --git a/src/Provider/ResourceData/GridResourceDataProvider.php b/src/Provider/ResourceData/GridResourceDataProvider.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\GridImportExport\Provider\ResourceData;
diff --git a/tests/TestApplication/config/config.yaml b/tests/TestApplication/config/config.yaml
@@ -8,3 +8,18 @@ parameters:
 twig:
     paths:
         '%kernel.project_dir%/../../../tests/TestApplication/templates': ~
+
+sylius_grid_import_export:
+    export:
+        default_provider: 'sylius_import_export.provider.resource_data.grid'
+        default_section: 'admin'
+        resources:
+            sylius.order:
+                sections:
+                    - 'Sylius\Bundle\AdminBundle\SectionResolver\AdminSection'
+            sylius.customer:
+                provider: 'sylius_import_export.provider.resource_data.dbal'
+            sylius.promotion: ~
+            sylius.product: ~
+            sylius.shipment: ~
+            sylius_grid_import_export.process: ~

Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,5 @@`
`17`	`17`
`18`	`18`	`interface ExportableCheckerInterface`
`19`	`19`	`{`
`20`		`- public function canBeExported(Grid $grid): bool;`
	`20`	`+ public function canBeExported(Grid $grid, object\|string\|null $section): bool;`
`21`	`21`	`}`