Proposal : filter on associated properties

doc/filters.rst

@@ -189,14 +189,30 @@ You can now use this custom filter in any of your dashboards and CRUD controller
         }
     }
 
+Filters on  associated entities
+-------------------------------
+(starting from version 3.x)
+If you need to filter by the property of a related entity (e.g.
+an ``order`` is associated with a ``customer`` and you want to filter orders by
+the ``last_visit`` property of the ``customer``), just use the dot notation to get to the property
+
+        public function configureFilters(Filters $filters): Filters
+        {
+            return $filters
+                // just as a string
+                ->add('customer.last_visit_date')
+                // or with an explicit type, either built-in or custom*
+                ->add(DateTimeFilter::new('customer.last_visit_date')
+            ;
+        }
+
+* Please note that, if you have pre-3.x custom filters, you'll have to update them to be able
+to work like this.
+
 Unmapped Filters
 ----------------
 
-By default, each filter must be associated with a property of the entity.
-However, sometimes you need to filter by the property of a related entity (e.g.
-an ``order`` is associated with a ``customer`` and you want to filter orders by
-the ``country`` property of the ``customer``). In those cases, set the
-``mapped`` option to ``false`` in the filter or you'll see an exception::
+In more complex cases, set the ``mapped`` option to ``false`` in the filter or you'll see an exception::
 
     namespace App\Controller\Admin;
 
@@ -214,9 +230,10 @@ the ``country`` property of the ``customer``). In those cases, set the
             return $filters
                 // 'country' doesn't exist as a property of 'Order' so it's
                 // defined as 'not mapped' to avoid errors
-                ->add(CustomerCountryFilter::new('country')->mapped(false))
+                ->add(CustomerCountryFilter::new('country')->setFormTypeOptions('mapped', false))
             ;
         }
     }
 
 .. TODO: explain and show an example of compound filter forms
+.. TODO : separate how filter is rendered (the filter form) and how it will go get the property

src/Dto/FilterDataDto.php

@@ -42,6 +42,11 @@ public function getProperty(): string
         return $this->filterDto->getProperty();
     }
 
+    public function getName(): string
+    {
+        return $this->filterDto->getName();
+    }
+
     public function getFormTypeOption(string $optionName)
     {
         return $this->filterDto->getFormTypeOption($optionName);

src/Dto/FilterDto.php

@@ -16,6 +16,7 @@ final class FilterDto
     private $propertyName;
     private $label;
     private $applyCallable;
+    private $name;
 
     public function __construct()
     {
@@ -75,6 +76,10 @@ public function getProperty(): string
     public function setProperty(string $propertyName): void
     {
         $this->propertyName = $propertyName;
+        if (is_null($this->name)) {
+            $parts = explode('.', $propertyName);
+            $this->name = end($parts);
+        }
     }
 
     /**
@@ -85,6 +90,18 @@ public function getLabel()
         return $this->label;
     }
 
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name)
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+
     /**
      * @param string|false|null $label
      */

src/Filter/ArrayFilter.php

@@ -47,6 +47,7 @@ public function canSelectMultiple(bool $selectMultiple = true): self
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
         $alias = $filterDataDto->getEntityAlias();
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();
         $parameterName = $filterDataDto->getParameterName();

src/Filter/BooleanFilter.php

@@ -29,6 +29,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $queryBuilder
             ->andWhere(sprintf('%s.%s %s :%s', $filterDataDto->getEntityAlias(), $filterDataDto->getProperty(), $filterDataDto->getComparison(), $filterDataDto->getParameterName()))
             ->setParameter($filterDataDto->getParameterName(), $filterDataDto->getValue());

src/Filter/ChoiceFilter.php

@@ -52,6 +52,7 @@ public function canSelectMultiple(bool $selectMultiple = true): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Filter/ComparisonFilter.php

@@ -29,6 +29,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Filter/Configurator/ComparisonConfigurator.php

@@ -24,6 +24,7 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
 
     public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $propertyType = $entityDto->getPropertyMetadata($filterDto->getProperty())->get('type');
 
         if (Types::DATEINTERVAL === $propertyType) {

src/Filter/Configurator/DateTimeConfigurator.php

@@ -25,6 +25,7 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
 
     public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $propertyType = $entityDto->getPropertyMetadata($filterDto->getProperty())->get('type');
 
         if (Types::DATE_MUTABLE === $propertyType) {

src/Filter/Configurator/EntityConfigurator.php

@@ -22,6 +22,7 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
 
     public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $propertyName = $filterDto->getProperty();
         if (!$entityDto->isAssociation($propertyName)) {
             return;

src/Filter/Configurator/NumericConfigurator.php

@@ -24,6 +24,7 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
 
     public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $propertyType = $entityDto->getPropertyMetadata($filterDto->getProperty())->get('type');
 
         if (Types::DECIMAL === $propertyType) {

src/Filter/Configurator/TextConfigurator.php

@@ -24,6 +24,7 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
 
     public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $propertyType = $entityDto->getPropertyMetadata($filterDto->getProperty())->get('type');
 
         if (Types::JSON === $propertyType) {

src/Filter/DateTimeFilter.php

@@ -30,6 +30,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Filter/EntityFilter.php

@@ -31,6 +31,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Filter/FilterTrait.php

@@ -28,7 +28,7 @@ private function __construct()
 
     public function __toString(): string
     {
-        return $this->dto->getProperty();
+        return $this->dto->getName();
     }
 
     public function setFilterFqcn(string $fqcn): self
@@ -38,6 +38,12 @@ public function setFilterFqcn(string $fqcn): self
         return $this;
     }
 
+    public function setName(string $name): self {
+        $this->dto->setName($name);
+
+        return $this;
+    }
+
     public function setProperty(string $propertyName): self
     {
         $this->dto->setProperty($propertyName);

src/Filter/NumericFilter.php

@@ -30,6 +30,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Filter/TextFilter.php

@@ -29,6 +29,7 @@ public static function new(string $propertyName, $label = null): self
 
     public function apply(QueryBuilder $queryBuilder, FilterDataDto $filterDataDto, ?FieldDto $fieldDto, EntityDto $entityDto): void
     {
+        // TODO : if filter property is compound, traverse the main property to get to the good one
         $alias = $filterDataDto->getEntityAlias();
         $property = $filterDataDto->getProperty();
         $comparison = $filterDataDto->getComparison();

src/Form/Type/FiltersFormType.php

@@ -20,7 +20,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     {
         /** @var FilterDto $filter */
         foreach ($options['ea_filters'] as $filter) {
-            $builder->add($filter->getProperty(), $filter->getFormType(), $filter->getFormTypeOptions());
+            $builder->add($filter->getName(), $filter->getFormType(), $filter->getFormTypeOptions());
         }
     }