Merge pull request #38 from RickvdStaaij/feature/values-in-callback

Make the filter data available in callbacks and custom filter rules
particle-php · Dec 10, 2015 · 78c2091 · 78c2091
2 parents 737a429 + 27d3993
commit 78c2091
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 7 deletions.
diff --git a/docs/filter-rules.md b/docs/filter-rules.md
@@ -62,9 +62,13 @@ $result = $f->filter(['newsletter' => 'yes']);
 
 Callback allows you to quickly add a custom filter, as you can provide a closure that manipulates the value.
 
+The callable function will receive two parameters from the callback rule. First `$value`, holding the
+currently filtered value for the current key. And second `$filterData`, holding all the data that is being
+filtered by the filter.
+
 ```php
 $f = new Filter;
-$f->value('name')->callback(function($value) {
+$f->value('name')->callback(function($value, $filterData) {
     return '<strong>' . $value . '</strong>';
 });
 $result = $f->filter(['name' => 'John']);
@@ -76,7 +80,7 @@ Callback can also be used if a value is not set in the filter data. Make sure yo
 
 ```php
 $f = new Filter;
-$f->value('year')->callback(function() {
+$f->value('year')->callback(function($value, $filterData) {
     return date('Y');
 }, true);
 $result = $f->filter([]); // note that no year is set

diff --git a/src/Chain.php b/src/Chain.php
@@ -25,12 +25,14 @@ class Chain
      *
      * @param bool $isSet
      * @param mixed $value
+     * @param array|null $filterData
      * @return FilterResult
      */
-    public function filter($isSet, $value = null)
+    public function filter($isSet, $value = null, $filterData = null)
     {
         /** @var FilterRule $rule */
         foreach ($this->rules as $rule) {
+            $rule->setFilterData($filterData);
             if ($isSet || $rule->allowedNotSet()) {
                 $value = $rule->filter($value);
                 $isSet = true;

diff --git a/src/Filter.php b/src/Filter.php
@@ -134,7 +134,7 @@ protected function filterGlobals(array $data)
             if (is_array($value)) {
                 $data[$key] = $this->filterGlobals($value);
             } else {
-                $filterResult = $this->globalChain->filter(true, $value);
+                $filterResult = $this->globalChain->filter(true, $value, $data);
                 $data[$key] = $filterResult->getFilteredValue();
             }
         }
@@ -152,10 +152,10 @@ protected function filterGlobals(array $data)
     protected function getFilterResult($key, Chain $chain)
     {
         if ($this->data->has($key)) {
-            return $chain->filter(true, $this->data->get($key));
+            return $chain->filter(true, $this->data->get($key), $this->data->getArrayCopy());
         }
 
-        return $chain->filter(false);
+        return $chain->filter(false, null, $this->data->getArrayCopy());
     }
 
     /**

diff --git a/src/FilterRule.php b/src/FilterRule.php
@@ -23,6 +23,11 @@ abstract class FilterRule
      */
     protected $allowNotSet = false;
 
+    /**
+     * @var array|null
+     */
+    protected $filterData;
+
     /**
      * @param string|null $encodingFormat
      */
@@ -31,6 +36,22 @@ public function setEncodingFormat($encodingFormat)
         $this->encodingFormat = $encodingFormat;
     }
 
+    /**
+     * @param array|null $filterData
+     */
+    public function setFilterData($filterData)
+    {
+        $this->filterData = $filterData;
+    }
+
+    /**
+     * @return array|null
+     */
+    public function getFilterData()
+    {
+        return $this->filterData;
+    }
+
     /**
      * @return bool
      */

diff --git a/src/FilterRule/Callback.php b/src/FilterRule/Callback.php
@@ -42,6 +42,6 @@ public function __construct(callable $callable, $allowNotSet = false)
      */
     public function filter($value)
     {
-        return call_user_func($this->callable, $value);
+        return call_user_func($this->callable, $value, $this->getFilterData());
     }
 }
diff --git a/tests/FilterRule/CallbackTest.php b/tests/FilterRule/CallbackTest.php
@@ -68,6 +68,24 @@ public function testNotSetWhenNotAllowedNotSet()
         $this->assertEquals([], $result);
     }
 
+    /**
+     * Test if the callback can build values using other data provided in the filter data
+     *
+     * @dataProvider getMultiValueCallbackResults
+     * @param array $values
+     * @param callable $callable
+     * @param mixed $filteredValue
+     */
+    public function testAccessFilterValuesInCallback($values, callable $callable, $filteredValue)
+    {
+        $this->filter->value('test')->callback($callable);
+
+        $result = $this->filter->filter($values);
+
+        $values['test'] = $filteredValue;
+        $this->assertEquals($values, $result);
+    }
+
     /**
      * @return array
      */
@@ -90,4 +108,34 @@ function ($value) {
             ],
         ];
     }
+
+    /**
+     * @return array
+     */
+    public function getMultiValueCallbackResults()
+    {
+        return [
+            [
+                [
+                    'gender' => 'Sir',
+                    'test' => 'John',
+                    'last_name' => 'Doe',
+                ],
+                function ($value, $filterValues) {
+                    return implode(' ', [$filterValues['gender'], $value, $filterValues['last_name']]);
+                },
+                'Sir John Doe',
+            ],
+            [
+                [
+                    'multiplier' => 10,
+                    'test' => 50,
+                ],
+                function ($value, $filterValues) {
+                    return $value * $filterValues['multiplier'];
+                },
+                500,
+            ],
+        ];
+    }
 }