Merge pull request #338 from GSadee/replace-custom-grid-invoice-chann…

…el-filter [Admin] Replace custom invoice_channel filter with entity filter from GridBundle
Sylius · Nov 20, 2024 · dc2ec13 · dc2ec13
2 parents 4bea6d1 + c46dd31
commit dc2ec13
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 97 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -27,10 +27,17 @@
    - `@SyliusInvoicingPlugin/Invoice/Grid/Field/orderNumber.html.twig`
    - `@SyliusInvoicingPlugin/Invoice/Grid/Field/channel.html.twig`
 
+1. The custom `invoice_channel` filter, its `Sylius\InvoicingPlugin\Grid\Filter\ChannelFilter` class 
+   and `Sylius\InvoicingPlugin\Form\Type\ChannelFilterType` form type have been removed and replaced by 
+   the `entity` filter from GridBundle.
+
 1. The invoice grid configuration has been updated accordingly to the above changes:
 
    ```diff
    sylius_grid:
+   -   templates:
+   -       filter:
+   -           invoice_channel: '@SyliusInvoicingPlugin/Grid/Filter/channel.html.twig'
        grids:
            sylius_invoicing_plugin_invoice:
    #           ...
@@ -52,5 +59,13 @@
                        options:
    -                       template: "@SyliusInvoicingPlugin/Invoice/Grid/Field/channel.html.twig"
    +                       template: "@SyliusAdmin/Order/Grid/Field/channel.html.twig"
+               filters:
+   #               ...
+                   channel:
+   -                   type: invoice_channel
+   +                   type: entity
+                       label: sylius.ui.channel
+   +                   form_options:
+   +                       class: "%sylius.model.channel.class%"
    #           ...
    ```
diff --git a/src/Form/Type/ChannelFilterType.php b/src/Form/Type/ChannelFilterType.php
diff --git a/src/Grid/Filter/ChannelFilter.php b/src/Grid/Filter/ChannelFilter.php
diff --git a/src/Resources/config/config.yml b/src/Resources/config/config.yml
@@ -27,9 +27,6 @@ winzou_state_machine:
                     args: ['object']
 
 sylius_grid:
-    templates:
-        filter:
-            invoice_channel: '@SyliusInvoicingPlugin/Grid/Filter/channel.html.twig'
     grids:
         sylius_invoicing_plugin_invoice:
             driver:
@@ -81,8 +78,10 @@ sylius_grid:
                     type: date
                     label: sylius_invoicing.ui.issued_at
                 channel:
-                    type: invoice_channel
+                    type: entity
                     label: sylius.ui.channel
+                    form_options:
+                        class: "%sylius.model.channel.class%"
             actions:
                 item:
                     show:

diff --git a/src/Resources/config/services/ui.xml b/src/Resources/config/services/ui.xml
@@ -7,14 +7,5 @@
         <service id="sylius_invoicing_plugin.ui.menu.admin_menu_listener" class="Sylius\InvoicingPlugin\Ui\Menu\AdminMenuListener">
             <tag name="kernel.event_listener" event="sylius.menu.admin.main" method="__invoke" />
         </service>
-
-        <service id="sylius_invoicing_plugin.form.type.channel_filter" class="Sylius\InvoicingPlugin\Form\Type\ChannelFilterType">
-            <argument type="service" id="sylius.repository.channel" />
-            <tag name="form.type" />
-        </service>
-
-        <service id="sylius_invoicing_plugin.grid.filter.channel" class="Sylius\InvoicingPlugin\Grid\Filter\ChannelFilter">
-            <tag name="sylius.grid_filter" type="invoice_channel" form_type="Sylius\InvoicingPlugin\Form\Type\ChannelFilterType" />
-        </service>
     </services>
 </container>
diff --git a/src/Resources/views/Grid/Filter/channel.html.twig b/src/Resources/views/Grid/Filter/channel.html.twig
diff --git a/tests/Behat/Page/Admin/Invoice/IndexPage.php b/tests/Behat/Page/Admin/Invoice/IndexPage.php
@@ -22,6 +22,6 @@ public function hasInvoiceWithChannel(int $index, string $channel): bool
 
     public function filterByChannel(string $channelName): void
     {
-        $this->getDocument()->find('css', '#criteria_channel_channel')->selectOption($channelName);
+        $this->getDocument()->find('css', '#criteria_channel')->selectOption($channelName);
     }
 }