Merge remote-tracking branch 'origin/main' into main

.github/workflows/code-quality.yml

@@ -2,6 +2,8 @@ name: Code Quality
 
 on:
   - push
+  - pull_request
+  - workflow_dispatch
 
 jobs:
   php-cs-fixer:

.github/workflows/testing.yml

@@ -2,6 +2,8 @@ name: Testing
 
 on:
   - push
+  - pull_request
+  - workflow_dispatch
 
 jobs:
   phpunit:

assets/controllers/batch.js

@@ -41,8 +41,12 @@ export default class extends Controller {
     #updateBatchActionBar() {
         const uniqueSelectedCount = this.#getUniqueSelectedCount();
 
-        this.selectedCounterTarget.innerHTML = uniqueSelectedCount;
-        this.batchActionBarTarget.hidden = uniqueSelectedCount === 0;
+        if (this.hasSelectedCounterTarget) {
+            this.selectedCounterTarget.innerHTML = uniqueSelectedCount;
+        }
+        if (this.hasBatchActionBarTarget) {
+            this.batchActionBarTarget.hidden = uniqueSelectedCount === 0;
+        }
     }
 
     #updateIndeterminateStates() {

composer.json

@@ -35,7 +35,8 @@
         "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^10.4",
         "dg/bypass-finals": "dev-master",
-        "openspout/openspout": "^4.23"
+        "openspout/openspout": "^4.23",
+        "symfony/http-foundation": "^6.0|^7.0"
     },
     "autoload": {
         "psr-4": {

docs/.vitepress/config.mts

@@ -13,9 +13,12 @@ export default defineConfig({
     externalLinkIcon: true,
     outline: 'deep',
 
+    search: {
+      provider: 'local',
+    },
+
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Home', link: '/' },
       { text: 'Documentation', link: '/docs/introduction', activeMatch: '/docs/' },
       { text: 'Reference', link: '/reference/types/data-table', activeMatch: '/reference/' },
     ],
@@ -91,6 +94,7 @@ export default defineConfig({
                 { text: 'DateTime', link: '/reference/types/column/date-time' },
                 { text: 'DatePeriod', link: '/reference/types/column/date-period' },
                 { text: 'Collection', link: '/reference/types/column/collection' },
+                { text: 'Enum', link: '/reference/types/column/enum' },
                 { text: 'Template', link: '/reference/types/column/template' },
                 { text: 'Actions', link: '/reference/types/column/actions' },
                 { text: 'Checkbox', link: '/reference/types/column/checkbox' },

docs/src/docs/features/theming.md

@@ -82,12 +82,33 @@ class ProductController extends AbstractController
 }
 ```
 
-Last but not least, you can also overwrite the themes of the data table inside a template:
+## Applying themes in Twig
+
+Similar to forms, you can set the data table themes directly in the Twig template, by using the `data_table_theme` tag:
 
 ```twig
-<div class="card">
-    {{ data_table(products, { themes: ['@KreyuDataTable/themes/bootstrap_5.html.twig'] }) }}
-</div>
+{% data_table_theme products 'themes/data_table.html.twig' %}
+
+{{ data_table(products) }}
+```
+
+If you wish to use multiple themes, pass an array using the `with` keyword:
+
+```twig
+{% data_table_theme products with [
+    'themes/data_table.html.twig', 
+    '@KreyuDataTable/themes/bootstrap_5.html.twig',
+] %}
+
+{{ data_table(products) }}
+```
+
+If you wish to disable currently configured themes for the data table and **only** use given ones, add the `only` keyword after the list of data table themes:
+
+```twig
+{% data_table_theme products with ['themes/data_table.html.twig'] only %}
+
+{{ data_table(products) }}
 ```
 
 ## Customizing existing theme
@@ -103,7 +124,7 @@ you can provide your own theme with only a fraction of Twig blocks,
 using the built-in themes as a fallback, for example:
 
 ```twig
-{# templates/data_table/theme.html.twig #}
+{# themes/data_table.html.twig #}
 {% block column_boolean_value %}
     {# ... #}
 {% endblock %}
@@ -114,7 +135,7 @@ using the built-in themes as a fallback, for example:
 kreyu_data_table:
   defaults:
     themes:
-      - 'templates/data_table/theme.html.twig',
+      - 'themes/data_table.html.twig',
       - '@KreyuDataTable/themes/bootstrap_5.html.twig'
 ```
 
@@ -123,7 +144,7 @@ use Symfony\Config\KreyuDataTableConfig;
 
 return static function (KreyuDataTableConfig $config) {
     $config->defaults()->themes([
-        'templates/data_table/theme.html.twig',
+        'themes/data_table.html.twig',
         '@KreyuDataTable/themes/bootstrap_5.html.twig',
     ]);
 };
@@ -139,7 +160,7 @@ class ProductDataTableType extends AbstractDataTableType
     {
         $resolver->setDefaults([
             'themes' => [
-                'templates/data_table/theme.html.twig',
+                'themes/data_table.html.twig',
                 '@KreyuDataTable/themes/bootstrap_5.html.twig',
             ],
         ]);
@@ -163,7 +184,7 @@ class ProductController extends AbstractController
             query: $query,
             options: [
                 'themes' => [
-                    'templates/data_table/theme.html.twig',
+                    'themes/data_table.html.twig',
                     '@KreyuDataTable/themes/bootstrap_5.html.twig',
                 ],
             ],
@@ -176,7 +197,7 @@ class ProductController extends AbstractController
 <div class="card">
     {{ data_table(products, { 
         themes: [
-            'templates/data_table/theme.html.twig',
+            'themes/data_table.html.twig',
             '@KreyuDataTable/themes/bootstrap_5.html.twig',
         ]
     }) }}

docs/src/docs/installation.md

@@ -14,7 +14,7 @@ This bundle can be installed at any moment during a project’s lifecycle.
 Use [Composer](https://getcomposer.org/) to install the bundle:
 
 ```shell
-composer require kreyu/data-table-bundle 0.17.*
+composer require kreyu/data-table-bundle 0.19.*
 ```
 
 ::: danger This bundle is not production ready!

docs/src/docs/usage.md

@@ -33,18 +33,19 @@ In most cases, the data tables are created in the controller, using the `createD
 
 ```php
 use App\Repository\ProductRepository;
+use App\DataTable\Type\ProductDataTableType;
+use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait; // [!code highlight]
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait; // [!code ++]
 
 class ProductController extends AbstractController
 {
-    use DataTableFactoryAwareTrait; // [!code ++]
+    use DataTableFactoryAwareTrait; // [!code highlight]
 
     public function index(ProductRepository $productRepository)
     {
-        $query = $productRepository->createQueryBuilder('product'); // [!code ++]
+        $queryBuilder = $productRepository->createQueryBuilder('product');
 
-        $dataTable = $this->createDataTable(ProductDataTableType::class, $query); // [!code ++]
+        $dataTable = $this->createDataTable(ProductDataTableType::class, $queryBuilder);
     }
 }
 ```
@@ -64,56 +65,65 @@ In order to be able to paginate, sort, filter, personalize or export the data ta
 
 ```php
 use App\Repository\ProductRepository;
+use App\DataTable\Type\ProductDataTableType;
+use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
-use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait;
 
 class ProductController extends AbstractController
 {
     use DataTableFactoryAwareTrait;
 
-    public function index(Request $request, ProductRepository $productRepository)
+    public function index(ProductRepository $productRepository) // [!code --]
+    public function index(Request $request, ProductRepository $productRepository) // [!code ++]
     {
-        $query = $productRepository->createQueryBuilder('product');
+        $queryBuilder = $productRepository->createQueryBuilder('product');
 
-        $dataTable = $this->createDataTable(ProductDataTableType::class, $query);
+        $dataTable = $this->createDataTable(ProductDataTableType::class, $queryBuilder);
         $dataTable->handleRequest($request); // [!code ++]
     }
 }
 ```
 
+This method calls the [request handler](./features/extensibility.md#request-handlers) to handle all the hard work.
+
 ## Rendering the data tables
 
 In order to render the data table, create the data table view and pass it to the template:
 
 ```php
 use App\Repository\ProductRepository;
+use App\DataTable\Type\ProductDataTableType;
+use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
-use Kreyu\Bundle\DataTableBundle\DataTableFactoryAwareTrait;
 
 class ProductController extends AbstractController
 {
     use DataTableFactoryAwareTrait;
 
     public function index(Request $request, ProductRepository $productRepository)
     {
-        $query = $productRepository->createQueryBuilder('product');
+        $queryBuilder = $productRepository->createQueryBuilder('product');
 
-        $dataTable = $this->createDataTable(ProductDataTableType::class, $query);
+        $dataTable = $this->createDataTable(ProductDataTableType::class, $queryBuilder);
         $dataTable->handleRequest($request);
 
-        return $this->render('product/index.html.twig', [
+        return $this->render('product/index.html.twig', [ // [!code ++]
             'products' => $dataTable->createView(), // [!code ++]
-        ]);
+        ]); // [!code ++]
     }
 }
 ```
 
+:::tip Don't forget to call the `createView()` method!
+This creates a `DataTableView` object, used to render the data table.
+:::
+
 Now, in the template, render the data table using the `data_table` function:
 
 ```twig
-{# product/index.html.twig #}
+{# templates/product/index.html.twig #}
 
 <div class="card">
     {{ data_table(products) }}

docs/src/reference/types/column/enum.md

@@ -0,0 +1,21 @@
+<script setup>
+    import ColumnTypeOptions from "./options/column.md";
+</script>
+
+# EnumColumnType
+
+The [`EnumColumnType`](https://github.com/Kreyu/data-table-bundle/blob/main/src/Column/Type/EnumColumnType.php) represents a column with [PHP enumeration](https://www.php.net/manual/language.enumerations.php) as value.
+
+## Overridden options
+
+### `formatter`
+
+- **type**: `null` or `callable`
+- **default**: callable that translates the enum if possible
+
+Formats the enum value. If Symfony Translator component is available, and the enum implements [`TranslatableInterface`](https://github.com/symfony/translation-contracts/blob/main/TranslatableInterface.php),
+the enum will be translated. Otherwise, the enum name will be displayed.
+
+## Inherited options
+
+<ColumnTypeOptions excludedOptions="['formatter']"/>

docs/src/reference/types/column/options/column.md

@@ -7,6 +7,10 @@ const props = defineProps({
             property_path: 'null',
         },
     },
+    excludedOptions: {
+        type: Array,
+        default: ['test'],
+    },
 })
 </script>
 
@@ -100,6 +104,8 @@ Allows you to add a custom block prefix and override the block name used to rend
 Useful for example if you have multiple instances of the same column type, and you need to personalize
 the rendering of some of them, without the need to create a new column type.
 
+<span v-if="!excludedOptions.includes('formatter')">
+
 ### `formatter`
 
 - **type**: `null` or `callable`
@@ -115,6 +121,8 @@ $builder
 ;
 ```
 
+</span>
+
 ### `export`
 
 - **type**: `bool` or `array`

src/Action/Type/LinkActionType.php

@@ -34,10 +34,10 @@ public function configureOptions(OptionsResolver $resolver): void
         $resolver
             ->setDefaults([
                 'href' => '#',
-                'target' => '_self',
+                'target' => null,
             ])
             ->setAllowedTypes('href', ['string', 'callable'])
-            ->setAllowedTypes('target', ['string', 'callable'])
+            ->setAllowedTypes('target', ['null', 'string', 'callable'])
         ;
     }
 }

src/Column/Type/EnumColumnType.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kreyu\Bundle\DataTableBundle\Column\Type;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+final class EnumColumnType extends AbstractColumnType
+{
+    public function __construct(
+        private ?TranslatorInterface $translator,
+    ) {
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefault('formatter', $this->format(...));
+    }
+
+    protected function format(\UnitEnum $enum): string
+    {
+        return $enum instanceof TranslatableInterface ? $enum->trans($this->translator) : $enum->name;
+    }
+
+    public function getParent(): ?string
+    {
+        return TextColumnType::class;
+    }
+}

src/Column/Type/LinkColumnType.php

@@ -31,10 +31,10 @@ public function configureOptions(OptionsResolver $resolver): void
         $resolver
             ->setDefaults([
                 'href' => '#',
-                'target' => '_self',
+                'target' => null,
             ])
             ->setAllowedTypes('href', ['string', 'callable'])
-            ->setAllowedTypes('target', ['string', 'callable'])
+            ->setAllowedTypes('target', ['null', 'string', 'callable'])
         ;
     }