Add the refresh_action

docs/src/docs/components/actions.md

@@ -672,3 +672,11 @@ Inside the template, we can render the modal however we want:
 ```
 
 For more details, see the [`ModalActionType`](../../reference/types/action/modal.md) reference page.
+
+## Refresh actions
+
+You have the option to add an action that refreshes the content of the DataTable.
+
+Thanks to `Hotwire Turbo`, only the content of the DataTable is refreshed.
+
+This action cannot be added as a `RowAction` or `BatchAction`.

docs/src/docs/features/asynchronicity.md

@@ -15,7 +15,7 @@ which wraps the whole table in the `<turbo-frame>` tag:
 ```twig
 {# @KreyuDataTable/themes/base.html.twig #}
 {% block kreyu_data_table %}
-    <turbo-frame id="kreyu_data_table_{{ name }}">
+    <turbo-frame id="{{ data_table_name(data_table) }}">
         {# ... #}
     </turbo-frame>
 {% endblock %}

src/Action/ActionRefreshUrlGenerator.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kreyu\Bundle\DataTableBundle\Action;
+
+use Kreyu\Bundle\DataTableBundle\Exception\LogicException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+class ActionRefreshUrlGenerator implements ActionRefreshUrlGeneratorInterface
+{
+    public function __construct(
+        private RequestStack $requestStack,
+        private UrlGeneratorInterface $urlGenerator,
+    ) {
+    }
+
+    public function generate(): string
+    {
+        $request = $this->getRequest();
+
+        $route = $request->attributes->get('_route');
+        $routeParams = $request->attributes->get('_route_params', []);
+        $queryParams = $request->query->all();
+
+        $parameters = [...$routeParams, ...$queryParams];
+
+        return $this->urlGenerator->generate($route, $parameters);
+    }
+
+    private function getRequest(): Request
+    {
+        if (null === $request = $this->requestStack->getCurrentRequest()) {
+            throw new LogicException('Unable to retrieve current request.');
+        }
+
+        return $request;
+    }
+}

src/Action/ActionRefreshUrlGeneratorInterface.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Kreyu\Bundle\DataTableBundle\Action;
+
+interface ActionRefreshUrlGeneratorInterface
+{
+    public function generate(): string;
+}

src/Action/Type/RefreshActionType.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kreyu\Bundle\DataTableBundle\Action\Type;
+
+use Kreyu\Bundle\DataTableBundle\Action\ActionContext;
+use Kreyu\Bundle\DataTableBundle\Action\ActionInterface;
+use Kreyu\Bundle\DataTableBundle\Action\ActionRefreshUrlGeneratorInterface;
+use Kreyu\Bundle\DataTableBundle\Action\ActionView;
+
+class RefreshActionType extends AbstractActionType
+{
+    public function __construct(
+        private ActionRefreshUrlGeneratorInterface $columnRefreshUrlGenerator,
+    ) {
+    }
+
+    public function buildView(ActionView $view, ActionInterface $action, array $options): void
+    {
+        if (ActionContext::Global !== $action->getConfig()->getContext()) {
+            throw new \LogicException(sprintf('A %s action can only be added as a global action.', $this::class));
+        }
+
+        $view->vars = array_replace($view->vars, [
+            'href' => $this->columnRefreshUrlGenerator->generate(),
+        ]);
+    }
+}

src/Resources/config/actions.php

@@ -4,20 +4,22 @@
 
 use Kreyu\Bundle\DataTableBundle\Action\ActionFactory;
 use Kreyu\Bundle\DataTableBundle\Action\ActionFactoryInterface;
+use Kreyu\Bundle\DataTableBundle\Action\ActionRefreshUrlGenerator;
 use Kreyu\Bundle\DataTableBundle\Action\ActionRegistry;
 use Kreyu\Bundle\DataTableBundle\Action\ActionRegistryInterface;
+use Kreyu\Bundle\DataTableBundle\Action\ActionRefreshUrlGeneratorInterface;
 use Kreyu\Bundle\DataTableBundle\Action\Type\ActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\ButtonActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\Dropdown\DropdownActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\Dropdown\LinkDropdownItemActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\FormActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\LinkActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\ModalActionType;
+use Kreyu\Bundle\DataTableBundle\Action\Type\RefreshActionType;
 use Kreyu\Bundle\DataTableBundle\Action\Type\ResolvedActionTypeFactory;
 use Kreyu\Bundle\DataTableBundle\Action\Type\ResolvedActionTypeFactoryInterface;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
-
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
 
@@ -55,6 +57,23 @@
         ->tag('kreyu_data_table.action.type')
     ;
 
+    $services
+        ->set('kreyu_data_table.action.type.refresh', RefreshActionType::class)
+        ->tag('kreyu_data_table.action.type')
+        ->args([service(ActionRefreshUrlGeneratorInterface::class)])
+    ;
+
+
+    $services
+        ->set('kreyu_data_table.action.action_refresh_url_generator', ActionRefreshUrlGenerator::class)
+        ->args([
+            service('request_stack'),
+            service(UrlGeneratorInterface::class),
+        ])
+        ->alias(ActionRefreshUrlGeneratorInterface::class, 'kreyu_data_table.action.action_refresh_url_generator')
+    ;
+
+
     $services
         ->set('kreyu_data_table.action.type.button', ButtonActionType::class)
         ->tag('kreyu_data_table.action.type')

src/Resources/views/themes/base.html.twig

@@ -9,7 +9,7 @@
         {% set stimulus_controllers = stimulus_controllers|merge(['kreyu--data-table-bundle--batch']) %}
     {% endif %}
 
-    <turbo-frame id="kreyu_data_table_{{ name }}" target="_top">
+    <turbo-frame id="{{ data_table_name(data_table) }}" target="_top">
         <div
             data-controller="{{ stimulus_controllers|join(' ') }}"
             data-kreyu--data-table-bundle--state-url-query-parameters-value="{{ url_query_parameters|default({})|json_encode }}"
@@ -33,7 +33,7 @@
         {% set stimulus_controllers = stimulus_controllers|merge(['kreyu--data-table-bundle--batch']) %}
     {% endif %}
 
-    <turbo-frame id="kreyu_data_table_{{ name }}" target="_top">
+    <turbo-frame id="{{ data_table_name(data_table) }}" target="_top">
         <div
             data-controller="{{ stimulus_controllers|join(' ') }}"
             data-kreyu--data-table-bundle--state-url-query-parameters-value="{{ url_query_parameters|default({})|json_encode }}"
@@ -621,6 +621,14 @@
     </a>
 {% endblock %}
 
+{% block action_refresh_control %}
+    {% set attr = { href }|filter(v => v != null)|merge(attr|default({'data-turbo-frame': data_table_name(data_table) })) %}
+
+    <a {% with { attr } %}{{- block('attributes') -}}{% endwith %}>
+        {% with { attr: {} } %}{{- block('action_control', theme, _context) -}}{% endwith %}
+    </a>
+{% endblock %}
+
 {% block action_form_control %}
     {% set attr = { action, method: html_friendly_method }|merge(attr|default({})) %}
 

src/Resources/views/themes/bootstrap_5.html.twig

@@ -717,6 +717,14 @@
     {{ parent() }}
 {% endblock %}
 
+{% block action_refresh_control %}
+    {% set attr = {
+        class: 'btn btn-primary',
+    }|merge(attr) %}
+
+    {{ parent() }}
+{% endblock %}
+
 {% block action_form_control %}
     {% set attr = { class: 'd-inline-block' }|merge(attr) %}
 

src/Twig/DataTableExtension.php

@@ -35,6 +35,7 @@ public function __construct(
     public function getFunctions(): array
     {
         $definitions = [
+            'data_table_name' => $this->getDataTableName(...),
             'data_table' => $this->renderDataTable(...),
             'data_table_table' => $this->renderDataTableTable(...),
             'data_table_action_bar' => $this->renderDataTableActionBar(...),
@@ -88,6 +89,11 @@ public function setDataTableThemes(DataTableView $view, array $themes, bool $onl
         }
     }
 
+    public function getDataTableName(Environment $environment, DataTableView $view): string
+    {
+        return 'kreyu_data_table_'.$view->vars['name'];
+    }
+
     /**
      * @param array<string, mixed> $variables
      *