Introduce AsField attribute to define field type

Author: loic425

src/Bundle/DependencyInjection/SyliusGridExtension.php

@@ -19,6 +19,7 @@
 use Sylius\Bundle\GridBundle\Grid\GridInterface;
 use Sylius\Bundle\GridBundle\SyliusGridBundle;
 use Sylius\Component\Grid\Annotation\AsGridFieldCallableService;
+use Sylius\Component\Grid\Attribute\AsField;
 use Sylius\Component\Grid\Attribute\AsFilter;
 use Sylius\Component\Grid\Data\DataProviderInterface;
 use Sylius\Component\Grid\Filtering\ConfigurableFilterInterface;
@@ -73,12 +74,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $container->registerAttributeForAutoconfiguration(
             AsFilter::class,
-            static function (ChildDefinition $definition, AsFilter $attribute, \Reflector $reflector): void {
-                // Helps to avoid issues with psalm
-                if (!$reflector instanceof \ReflectionClass) {
-                    return;
-                }
-
+            static function (ChildDefinition $definition, AsFilter $attribute, \ReflectionClass $reflector): void {
                 $definition->addTag(AsFilter::SERVICE_TAG, [
                     'type' => $attribute->type ?? $reflector->getName(),
                     'form_type' => $attribute->formType,
@@ -87,6 +83,15 @@ static function (ChildDefinition $definition, AsFilter $attribute, \Reflector $r
             },
         );
 
+        $container->registerAttributeForAutoconfiguration(
+            AsField::class,
+            static function (ChildDefinition $definition, AsField $attribute, \ReflectionClass $reflector): void {
+                $definition->addTag(AsField::SERVICE_TAG, [
+                    'type' => $attribute->type ?? $reflector->getName(),
+                ]);
+            },
+        );
+
         $container->registerForAutoconfiguration(ConfigurableFilterInterface::class)
             ->addTag(AsFilter::SERVICE_TAG)
         ;

src/Bundle/Tests/Integration/CustomFiltersTest.php

@@ -0,0 +1,32 @@
+<?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 Integration;
+
+use App\Field\FirstCustomField;
+use Sylius\Component\Registry\ServiceRegistry;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+final class CustomFiltersTest extends KernelTestCase
+{
+    public function testItRegistersCustomFilters(): void
+    {
+        $container = static::getContainer();
+
+        /** @var ServiceRegistry $fieldRegistry */
+        $fieldRegistry = $container->get('sylius.registry.grid_field');
+
+        self::assertTrue($fieldRegistry->has(FirstCustomField::class));
+        self::assertTrue($fieldRegistry->has('custom_two'));
+    }
+}

src/Component/Attribute/AsField.php

@@ -0,0 +1,25 @@
+<?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\Component\Grid\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsField
+{
+    public const SERVICE_TAG = 'sylius.grid_field';
+
+    public function __construct(
+        public readonly ?string $type = null,
+    ) {
+    }
+}

tests/Application/config/services.yaml

@@ -25,8 +25,13 @@ services:
             - '@app.repository.author'
         public: true
 
-    App\Filter\AttributeNationalityFilter: null
-    App\Filter\NationalityFilter: null
+    # Fields
+    App\Field\:
+        resource: '../src/Field'
+
+    # Filters
+    App\Filter\:
+        resource: '../src/Filter'
 
     App\BoardGameBlog\:
         resource: '../src/BoardGameBlog'

tests/Application/src/Field/FirstCustomField.php

@@ -0,0 +1,32 @@
+<?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 App\Field;
+
+use Sylius\Component\Grid\Attribute\AsField;
+use Sylius\Component\Grid\Definition\Field;
+use Sylius\Component\Grid\FieldTypes\FieldTypeInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+#[AsField]
+class FirstCustomField implements FieldTypeInterface
+{
+    public function render(Field $field, $data, array $options): string
+    {
+        return '';
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+    }
+}

tests/Application/src/Field/SecondCustomField.php

@@ -0,0 +1,32 @@
+<?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 App\Field;
+
+use Sylius\Component\Grid\Attribute\AsField;
+use Sylius\Component\Grid\Definition\Field;
+use Sylius\Component\Grid\FieldTypes\FieldTypeInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+#[AsField(type: 'custom_two')]
+class SecondCustomField implements FieldTypeInterface
+{
+    public function render(Field $field, $data, array $options): string
+    {
+        return '';
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+    }
+}