refactor: Making filter path configurable

dontdrinkandroot · Apr 4, 2024 · 7fa205f · 7fa205f
1 parent e9e59b9
commit 7fa205f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 13 deletions.
diff --git a/src/Model/FieldDefinition.php b/src/Model/FieldDefinition.php
@@ -17,7 +17,8 @@ public function __construct(
         public readonly array $crudOperations = [],
         public readonly ?string $formType = null,
         public readonly bool $sortable = false,
-        public readonly bool $filterable = false
+        public readonly bool $filterable = false,
+        public readonly ?string $filterPath = null,
     ) {
     }
 }
diff --git a/src/Service/FieldDefinition/StaticFieldDefinitionsProvider.php b/src/Service/FieldDefinition/StaticFieldDefinitionsProvider.php
@@ -41,6 +41,7 @@ public function provideFieldDefinitions(string $entityClass): ?array
                 formType: $fieldDefinitionConfiguration['form_type'] ?? null,
                 sortable: $fieldDefinitionConfiguration['sortable'] ?? false,
                 filterable: $fieldDefinitionConfiguration['filterable'] ?? false,
+                filterPath: $fieldDefinitionConfiguration['filter_path'] ?? null
             );
         }
 

diff --git a/src/Service/Pagination/DefaultPaginationProvider.php b/src/Service/Pagination/DefaultPaginationProvider.php
@@ -7,6 +7,7 @@
 use Dontdrinkandroot\Common\Asserted;
 use Dontdrinkandroot\Common\CrudOperation;
 use Dontdrinkandroot\CrudAdminBundle\Model\DefaultSort;
+use Dontdrinkandroot\CrudAdminBundle\Model\FieldDefinition;
 use Dontdrinkandroot\CrudAdminBundle\Service\FieldDefinition\FieldDefinitionsResolverInterface;
 use Dontdrinkandroot\CrudAdminBundle\Service\PaginationTarget\PaginationTargetResolver;
 use Dontdrinkandroot\CrudAdminBundle\Service\Sort\DefaultSortProviderInterface;
@@ -50,21 +51,13 @@ public function providePagination(string $entityClass): ?PaginationInterface
             $this->fieldDefinitionsResolver->resolveFieldDefinitions($entityClass, CrudOperation::LIST)
         );
         foreach ($fieldDefinitions as $fieldDefinition) {
+
             if ($fieldDefinition->sortable) {
-                if (str_contains($fieldDefinition->propertyPath, '.')) {
-                    /* If it contains a dot, it's a joined field, so we don't need to prefix it */
-                    $sortFields[] = $fieldDefinition->propertyPath;
-                } else {
-                    $sortFields[] = $fieldPrefix . $fieldDefinition->propertyPath;
-                }
+                $sortFields[] = $this->getSortFieldPath($fieldDefinition, $fieldPrefix);
             }
+
             if ($fieldDefinition->filterable) {
-                if (str_contains($fieldDefinition->propertyPath, '.')) {
-                    /* If it contains a dot, it's a joined field, so we don't need to prefix it */
-                    $filterFields[] = $fieldDefinition->propertyPath;
-                } else {
-                    $filterFields[] = $fieldPrefix . $fieldDefinition->propertyPath;
-                }
+                $filterFields[] = $this->getFilterFieldPath($fieldDefinition, $fieldPrefix);
             }
         }
 
@@ -113,4 +106,25 @@ private function resolveDefaultSort(string $entityClass): ?DefaultSort
 
         return null;
     }
+
+    private function getSortFieldPath(FieldDefinition $fieldDefinition, string $prefix): string
+    {
+        if (str_contains($fieldDefinition->propertyPath, '.')) {
+            /* If it contains a dot, it's a joined field, so we don't need to prefix it */
+            return $fieldDefinition->propertyPath;
+        }
+
+        return $prefix . $fieldDefinition->propertyPath;
+    }
+
+    private function getFilterFieldPath(FieldDefinition $fieldDefinition, string $prefix): string
+    {
+        $path = $fieldDefinition->filterPath ?? $fieldDefinition->propertyPath;
+        if (str_contains($path, '.')) {
+            /* If it contains a dot, it's a joined field, so we don't need to prefix it */
+            return $path;
+        }
+
+        return $prefix . $path;
+    }
 }