feat: add a criteria provider to allow simple querying without creating a custom provider

config/bridges/orm.php

@@ -14,6 +14,7 @@
 use LAG\AdminBundle\Bridge\Doctrine\ORM\Metadata\MetadataPropertyFactory;
 use LAG\AdminBundle\Bridge\Doctrine\ORM\Metadata\MetadataPropertyFactoryInterface;
 use LAG\AdminBundle\Bridge\Doctrine\ORM\State\Processor\ORMProcessor;
+use LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider\CriteriaProvider;
 use LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider\DoctrineCollectionNormalizeProvider;
 use LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider\ORMProvider;
 use LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider\PaginationProvider;
@@ -37,7 +38,11 @@
         ->tag('lag_admin.state_provider', ['identifier' => 'doctrine', 'priority' => 0])
     ;
     $services->set(SortingProvider::class)
-        ->decorate(ProviderInterface::class, priority: 300)
+        ->decorate(ProviderInterface::class, priority: 230)
+        ->arg('$provider', service('.inner'))
+    ;
+    $services->set(CriteriaProvider::class)
+        ->decorate(ProviderInterface::class, priority: 220)
         ->arg('$provider', service('.inner'))
     ;
     $services->set(PaginationProvider::class)

src/Bridge/Doctrine/ORM/Exception/ORMException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LAG\AdminBundle\Bridge\Doctrine\ORM\Exception;
+
+use LAG\AdminBundle\Exception\Exception;
+
+final class ORMException extends Exception
+{
+}

src/Bridge/Doctrine/ORM/State/Provider/CriteriaProvider.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider;
+
+use Doctrine\ORM\QueryBuilder;
+use LAG\AdminBundle\Resource\Metadata\CollectionOperationInterface;
+use LAG\AdminBundle\Resource\Metadata\OperationInterface;
+use LAG\AdminBundle\State\Provider\ProviderInterface;
+use function Symfony\Component\String\u;
+
+final readonly class CriteriaProvider implements ProviderInterface
+{
+    public function __construct(
+        private ProviderInterface $provider,
+    ) {
+    }
+
+    public function provide(OperationInterface $operation, array $uriVariables = [], array $context = []): mixed
+    {
+        $data = $this->provider->provide($operation, $uriVariables, $context);
+
+        if (!$data instanceof QueryBuilder) {
+            return $data;
+        }
+
+        if (!$operation instanceof CollectionOperationInterface || $operation->getCriteria() === []) {
+            return $data;
+        }
+
+        foreach ($operation->getCriteria() as $criteria => $value) {
+            $alias = $data->getRootAliases()[0];
+            $dql = u('entity.field = :'.$criteria.'_value')
+                ->replace('entity', $alias)
+                ->replace('field', $criteria)
+            ;
+            $data->andWhere($dql->toString())
+                ->setParameter($criteria.'_value', $value)
+            ;
+        }
+
+        return $data;
+    }
+}

src/Bridge/Doctrine/ORM/State/Provider/SortingProvider.php

@@ -5,6 +5,7 @@
 namespace LAG\AdminBundle\Bridge\Doctrine\ORM\State\Provider;
 
 use Doctrine\ORM\QueryBuilder;
+use LAG\AdminBundle\Bridge\Doctrine\ORM\Exception\ORMException;
 use LAG\AdminBundle\Resource\Metadata\CollectionOperationInterface;
 use LAG\AdminBundle\Resource\Metadata\OperationInterface;
 use LAG\AdminBundle\State\Provider\ProviderInterface;
@@ -35,7 +36,15 @@ public function provide(OperationInterface $operation, array $uriVariables = [],
 
         foreach ($orderBy as $field => $direction) {
             $property = $resource->getProperty($field);
-            $order = u($property->getPropertyPath() ?? $field);
+            $sort = $property->getSortingPath();
+
+            if ($sort === null) {
+                throw new ORMException(\sprintf(
+                    'The property "%s" can not be sorted by as the sorting path is null.',
+                    $property->getName(),
+                ));
+            }
+            $order = u($sort);
 
             if ($order->containsAny('.')) {
                 $alias = $rootAlias;

src/EventListener/Resource/InitializeResourcePropertiesListener.php

@@ -65,10 +65,17 @@ private function initializeProperty(Resource $resource, PropertyInterface $prope
             }
         }
 
-        if ($property instanceof Link) {
-            if ($property->getText() === null) {
-                $property = $property->withText($property->getName());
+        if ($property instanceof Link && $property->getText() === null) {
+            $property = $property->withText($property->getName());
+        }
+
+        if ($property->isSortable() && $property->getSortingPath() === null) {
+            $sortingPath = $property->getName();
+
+            if (is_string($property->getPropertyPath())) {
+                $sortingPath = $property->getPropertyPath();
             }
+            $property = $property->withSortingPath($sortingPath);
         }
 
         return $property;

src/Resource/Metadata/Action.php

@@ -19,6 +19,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         private ?string $route = null,
         private array $routeParameters = [],
@@ -44,6 +45,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Boolean.php

@@ -19,7 +19,8 @@ public function __construct(
         array $headerAttributes = [],
         ?string $dataTransformer = null,
         ?array $permissions = null,
-        ?string $condition = null
+        ?string $condition = null,
+        ?string $sortingPath = null,
     ) {
         parent::__construct(
             name: $name,
@@ -34,6 +35,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 }

src/Resource/Metadata/Collection.php

@@ -23,6 +23,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         #[Assert\NotNull(message: 'The collection should have an property for each entry')]
         private ?PropertyInterface $entryProperty = null,
@@ -41,6 +42,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Compound.php

@@ -20,6 +20,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         private array $properties = [],
     ) {
@@ -36,6 +37,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Count.php

@@ -19,6 +19,7 @@ public function __construct(
         ?string $dataTransformer = CountDataTransformer::class,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
     ) {
         parent::__construct(
             name: $name,
@@ -31,6 +32,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 }

src/Resource/Metadata/Date.php

@@ -21,6 +21,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         #[Assert\NotBlank(message: 'The date format should not be empty. Use "none" instead')]
         private string $dateFormat = 'medium',
@@ -41,6 +42,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Group.php

@@ -18,10 +18,10 @@ public function __construct(
     ) {
         parent::__construct(
             name: $name,
+            propertyPath: '.',
             label: $label,
             template: '@LAGAdmin/grids/properties/group.html.twig',
             sortable: false,
-            propertyPath: '.',
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,

src/Resource/Metadata/Link.php

@@ -27,6 +27,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         private ?string $route = null,
         private array $routeParameters = [],
@@ -41,8 +42,8 @@ public function __construct(
         parent::__construct(
             name: $name,
             propertyPath: $propertyPath,
-            template: $template,
             label: $label,
+            template: $template,
             sortable: $sortable,
             translatable: $translatable,
             translationDomain: $translationDomain,
@@ -52,6 +53,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Map.php

@@ -21,6 +21,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         #[Assert\Count(min: 1, minMessage: 'The map should have at least 1 element')]
         private array $map = [],
@@ -38,6 +39,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Property.php

@@ -35,7 +35,7 @@ public function __construct(
 
         private bool $translatable = false,
 
-        #[Assert\NotBlank(allowNull: true, message: 'The translation domain should not be empty. Use null instead')]
+        #[Assert\NotBlank(message: 'The translation domain should not be empty. Use null instead', allowNull: true)]
         private ?string $translationDomain = null,
 
         private array $attributes = [],
@@ -44,13 +44,20 @@ public function __construct(
 
         private array $headerAttributes = [],
 
-        #[Assert\NotBlank(allowNull: true, message: 'The data transformer should not be empty. Use null instead')]
+        #[Assert\NotBlank(message: 'The data transformer should not be empty. Use null instead', allowNull: true)]
         private ?string $dataTransformer = null,
 
         private ?array $permissions = null,
 
         #[WorkflowInstalled]
         private ?string $condition = null,
+
+        #[Assert\NotBlank(message: 'The sorting path should not be empty. Use null instead', allowNull: true)]
+        #[Assert\Expression(
+            expression: '(this.isSortable() and this.getSortingPath() !== null) or !this.isSortable()',
+            message: 'The sorting path should not be null if the property is sortable',
+        )]
+        private ?string $sortingPath = null,
     ) {
     }
 
@@ -235,4 +242,17 @@ public function withCondition(?string $condition): self
 
         return $self;
     }
+
+    public function getSortingPath(): ?string
+    {
+        return $this->sortingPath;
+    }
+
+    public function withSortingPath(?string $sortingPath): self
+    {
+        $self = clone $this;
+        $self->sortingPath = $sortingPath;
+
+        return $self;
+    }
 }

src/Resource/Metadata/PropertyInterface.php

@@ -157,4 +157,8 @@ public function getPermissions(): ?array;
      * Define the property permissions.
      */
     public function withPermissions(array $permissions): self;
+
+    public function getSortingPath(): ?string;
+
+    public function withSortingPath(?string $sortingPath): self;
 }

src/Resource/Metadata/ResourceLink.php

@@ -23,6 +23,7 @@ public function __construct(
         string $emptyString = '~',
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         #[NotBlank]
         private ?string $application = null,
@@ -42,11 +43,12 @@ public function __construct(
             translationDomain: $translationDomain,
             attributes: $attributes,
             headerAttributes: $headerAttributes,
+            permissions: $permissions,
+            condition: $condition,
+            sortingPath: $sortingPath,
             length: $length,
             replace: $replace,
             empty: $emptyString,
-            permissions: $permissions,
-            condition: $condition,
         );
     }
 

src/Resource/Metadata/RichText.php

@@ -21,6 +21,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
 
         #[Assert\Length(min: 1)]
         private int $length = 100,
@@ -42,6 +43,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath,
         );
     }
 

src/Resource/Metadata/Slug.php

@@ -24,6 +24,7 @@ public function __construct(
         ?string $dataTransformer = null,
         ?array $permissions = null,
         ?string $condition = null,
+        ?string $sortingPath = null,
     ) {
         parent::__construct(
             name: $name,
@@ -38,6 +39,7 @@ public function __construct(
             dataTransformer: $dataTransformer,
             permissions: $permissions,
             condition: $condition,
+            sortingPath: $sortingPath
         );
     }