Add FilterScope to every Filter

Author: jissereitsma

Component/ComponentViewModel.php

@@ -55,7 +55,7 @@ public function getValue(): mixed
         }
 
         $value = $this->getComponent()->getRepository()->getValue();
-        $value = $this->filter->filter($this->getComponent()->getFilters(), $value);
+        $value = $this->filter->filter($this->getComponent(), $value);
 
         if (false === $this->component->isValidated()) {
             $this->validator->validate($this->component, $value);

Filter/Capitalize.php

@@ -2,11 +2,9 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 class Capitalize implements FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed
+    public function filter(mixed $value, FilterScope $scope): mixed
     {
         return ucfirst((string)$value);
     }

Filter/Filter.php

@@ -7,34 +7,38 @@
 class Filter
 {
     public function __construct(
-        private readonly FilterRegistry $filterRegistry
+        private readonly FilterRegistry $filterRegistry,
+        private readonly FilterScopeFactory $filterScopeFactory,
     ) {
     }
 
     public function filter(
         ComponentInterface $component,
         mixed $data = null,
-        ?string $scope = null
+        mixed $propertyName = null
     ): mixed {
-        $requestedFilters = $component->getFilters();
+        $filters = $this->filterRegistry->getApplicableFilters(
+            $component->getFilters()
+        );
+
+        $filterScope = $this->filterScopeFactory->create();
+        $filterScope->setComponent($component);
+        $filterScope->setProperty($propertyName);
 
         if (empty($data) || is_bool($data) || is_int($data)) {
             return $data;
         }
 
         if (is_array($data)) {
-            foreach ($data as $name => $value) {
-                $data[$name] = $this->filter($component, $value, $name);
+            foreach ($data as $propertyName => $value) {
+                $data[$propertyName] = $this->filter($component, $value, $propertyName);
             }
 
             return $data;
         }
 
-        $filters = $this->filterRegistry->getApplicableFilters(
-            $requestedFilters
-        );
         foreach ($filters as $filter) {
-            $data = $filter->filter($data, $component, $scope);
+            $data = $filter->filter($data, $filterScope);
         }
 
         return $data;

Filter/FilterInterface.php

@@ -3,9 +3,7 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 interface FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed;
+    public function filter(mixed $value, FilterScope $scope): mixed;
 }

Filter/FilterScope.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace Loki\Components\Filter;
+
+use Loki\Components\Component\ComponentInterface;
+
+class FilterScope
+{
+    private ComponentInterface|null $component = null;
+    private mixed $property = null;
+
+    public function getComponent(): ?ComponentInterface
+    {
+        return $this->component;
+    }
+
+    public function setComponent(?ComponentInterface $component): void
+    {
+        $this->component = $component;
+    }
+
+    public function getProperty(): mixed
+    {
+        return $this->property;
+    }
+
+    public function setProperty(mixed $property): void
+    {
+        $this->property = $property;
+    }
+}

Filter/FilterScopeFactory.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace Loki\Components\Filter;
+
+use Magento\Framework\ObjectManagerInterface;
+
+class FilterScopeFactory
+{
+    public function __construct(
+        private ObjectManagerInterface $objectManager,
+    ){
+    }
+
+    public function create(): FilterScope
+    {
+        return $this->objectManager->create(FilterScope::class);
+    }
+}

Filter/Lowercase.php

@@ -2,11 +2,9 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 class Lowercase implements FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed
+    public function filter(mixed $value, FilterScope $scope): mixed
     {
         return strtolower((string)$value);
     }

Filter/Number.php

@@ -2,11 +2,9 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 class Number implements FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed
+    public function filter(mixed $value, FilterScope $scope): mixed
     {
         return (int)$value;
     }

Filter/PositiveNumber.php

@@ -2,11 +2,9 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 class PositiveNumber implements FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed
+    public function filter(mixed $value, FilterScope $scope): mixed
     {
         if ($value > 0) {
             return $value;

Filter/Security.php

@@ -2,18 +2,16 @@
 
 namespace Loki\Components\Filter;
 
-use Loki\Components\Component\ComponentInterface;
-
 class Security implements FilterInterface
 {
-    public function filter(mixed $value, ?ComponentInterface $component = null, ?string $scope = null): mixed
+    public function filter(mixed $value, FilterScope $scope): mixed
     {
        if (is_object($value)) {
             return $value;
         }
 
         $value = (string)$value;
-        //$value = strip_tags($value);
+        $value = strip_tags($value);
         $value = htmlspecialchars_decode($value);
         return $value;
     }