Some slight refactoring for name consistency

mattgrul · Dec 9, 2020 · afeed2e · afeed2e
1 parent e845f7f
commit afeed2e
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 11 deletions.
diff --git a/Api/HyvaGridFilterTypeInterface.php b/Api/HyvaGridFilterTypeInterface.php
@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace Hyva\Admin\Api;
+
+use Hyva\Admin\ViewModel\HyvaGrid\ColumnDefinitionInterface;
+use Hyva\Admin\ViewModel\HyvaGrid\GridFilterInterface;
+use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\View\Element\Template;
+
+interface HyvaGridFilterTypeInterface
+{
+    public function getRenderer(ColumnDefinitionInterface $columnDefinition): Template;
+
+    public function apply(
+        SearchCriteriaBuilder $searchCriteriaBuilder,
+        GridFilterInterface $gridFilter,
+        $filterValue
+    ): void;
+}
diff --git a/Model/GridFilter/ColumnDefinitionMatchingFilterInterface.php b/Model/GridFilter/ColumnDefinitionMatchingFilterInterface.php
@@ -2,11 +2,10 @@
 
 namespace Hyva\Admin\Model\GridFilter;
 
-use Hyva\Admin\Api\GridFilterTypeInterface;
-use Hyva\Admin\ViewModel\HyvaGrid\ColumnDefinitionInterface;
+use Hyva\Admin\Api\HyvaGridFilterTypeInterface;
 use Hyva\Admin\ViewModel\HyvaGrid\GridFilterInterface;
 
-interface ColumnDefinitionMatchingFilterInterface extends GridFilterTypeInterface
+interface ColumnDefinitionMatchingFilterInterface extends HyvaGridFilterTypeInterface
 {
     public function isMatchingFilter(GridFilterInterface $filter): bool;
 }
diff --git a/Model/GridFilter/GridFilterTypeLocator.php b/Model/GridFilter/GridFilterTypeLocator.php
@@ -2,7 +2,7 @@
 
 namespace Hyva\Admin\Model\GridFilter;
 
-use Hyva\Admin\Api\GridFilterTypeInterface;
+use Hyva\Admin\Api\HyvaGridFilterTypeInterface;
 use Hyva\Admin\ViewModel\HyvaGrid\ColumnDefinitionInterface;
 use Hyva\Admin\ViewModel\HyvaGrid\GridFilterInterface;
 use Magento\Framework\ObjectManagerInterface;
@@ -22,7 +22,7 @@ public function __construct(ObjectManagerInterface $objectManager, array $column
     public function findFilterForColumn(
         GridFilterInterface $gridFilter,
         ColumnDefinitionInterface $columnDefinition
-    ): GridFilterTypeInterface {
+    ): HyvaGridFilterTypeInterface {
         foreach ($this->columnTypeMatchingFilterTypeMap as $type) {
             $filterType = $this->get($type);
             if ($this->canMatchColumn($filterType) && $filterType->isMatchingFilter($gridFilter, $columnDefinition)) {
@@ -34,12 +34,12 @@ public function findFilterForColumn(
         throw new \OutOfBoundsException($msg);
     }
 
-    private function canMatchColumn(GridFilterTypeInterface $filterType): bool
+    private function canMatchColumn(HyvaGridFilterTypeInterface $filterType): bool
     {
         return $filterType instanceof ColumnDefinitionMatchingFilterInterface;
     }
 
-    public function get(string $filterType): GridFilterTypeInterface
+    public function get(string $filterType): HyvaGridFilterTypeInterface
     {
         return $this->objectManager->get($filterType);
     }

diff --git a/Test/Functional/ViewModel/HyvaGrid/StubTestFilterType.php b/Test/Functional/ViewModel/HyvaGrid/StubTestFilterType.php
@@ -2,13 +2,13 @@
 
 namespace Hyva\Admin\Test\Functional\ViewModel\HyvaGrid;
 
-use Hyva\Admin\Api\GridFilterTypeInterface;
+use Hyva\Admin\Api\HyvaGridFilterTypeInterface;
 use Hyva\Admin\ViewModel\HyvaGrid\ColumnDefinitionInterface;
 use Hyva\Admin\ViewModel\HyvaGrid\GridFilterInterface;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\View\Element\Template;
 
-class StubTestFilterType implements GridFilterTypeInterface
+class StubTestFilterType implements HyvaGridFilterTypeInterface
 {
     const STUB_OUTPUT = 'This is the output of the dummy filter type';
 

diff --git a/ViewModel/HyvaGrid/GridFilter.php b/ViewModel/HyvaGrid/GridFilter.php
@@ -2,7 +2,7 @@
 
 namespace Hyva\Admin\ViewModel\HyvaGrid;
 
-use Hyva\Admin\Api\GridFilterTypeInterface;
+use Hyva\Admin\Api\HyvaGridFilterTypeInterface;
 use Hyva\Admin\Model\GridFilter\GridFilterTypeLocator;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\RequestInterface;
@@ -73,7 +73,7 @@ private function renderFilter(): string
         return $renderer->toHtml();
     }
 
-    private function getFilterType(): GridFilterTypeInterface
+    private function getFilterType(): HyvaGridFilterTypeInterface
     {
         return $this->filterType
             ? $this->gridFilterTypeLocator->get($this->filterType)

diff --git a/todo.md b/todo.md
@@ -5,6 +5,8 @@ Later, when the module stabilizes, this file can be deleted and todo's can be ma
 
 ## Next steps:
 
+* test mass action and row action id parameter passing
+* test grid without default sort column doesn't have surprising behavior
 * add ui element to remove all filter values
 * test boolean data type when rendering grid
 * collection source type