Use 'conflictsWith' in Filterer

Author: chadicus

src/Filterer.php

@@ -123,12 +123,15 @@ public function execute(array $input) : FilterResponse
         $leftOverInput = array_diff_key($input, $this->specification);
 
         $errors = [];
+        $conflicts = [];
         foreach ($inputToFilter as $field => $input) {
             $filters = $this->specification[$field];
             self::assertFiltersIsAnArray($filters, $field);
             $customError = self::validateCustomError($filters, $field);
             unset($filters[FilterOptions::IS_REQUIRED]);//doesn't matter if required since we have this one
             unset($filters[FilterOptions::DEFAULT_VALUE]);//doesn't matter if there is a default since we have a value
+            $conflicts = self::extractConflicts($filters, $field, $conflicts);
+
             foreach ($filters as $filter) {
                 self::assertFilterIsNotArray($filter, $field);
 
@@ -165,6 +168,7 @@ public function execute(array $input) : FilterResponse
         }
 
         $errors = self::handleAllowUnknowns($this->allowUnknowns, $leftOverInput, $errors);
+        $errors = self::handleConflicts($inputToFilter, $conflicts, $errors);
 
         return new FilterResponse($inputToFilter, $errors, $leftOverInput);
     }
@@ -179,6 +183,40 @@ public function getAliases() : array
         return $this->filterAliases ?? self::$registeredFilterAliases;
     }
 
+    private static function extractConflicts(array &$filters, string $field, array $conflicts) : array
+    {
+        $conflictsWith = $filters[FilterOptions::CONFLICTS_WITH] ?? null;
+        unset($filters[FilterOptions::CONFLICTS_WITH]);
+        if ($conflictsWith === null) {
+            return $conflicts;
+        }
+
+        if (!is_array($conflictsWith)) {
+            $conflictsWith = [$conflictsWith];
+        }
+
+        $conflicts[$field] = $conflictsWith;
+
+        return $conflicts;
+    }
+
+    private static function handleConflicts(array $inputToFilter, array $conflicts, array $errors)
+    {
+        foreach (array_keys($inputToFilter) as $field) {
+            if (!array_key_exists($field, $conflicts)) {
+                continue;
+            }
+
+            foreach ($conflicts[$field] as $conflictsWith) {
+                if (array_key_exists($conflictsWith, $inputToFilter)) {
+                    $errors[] = "Field '{$field}' cannot be given if field '{$conflictsWith}' is present.";
+                }
+            }
+        }
+
+        return $errors;
+    }
+
     /**
      * @return array
      *

tests/FiltererTest.php

@@ -238,6 +238,64 @@ public function provideValidFilterData() : array
                 'options' => [],
                 'result' => [true, ['field' => 'a string with newlines and extra spaces'], null, []],
             ],
+            'conflicts with single' => [
+                'spec' => [
+                    'fieldOne' => [FilterOptions::CONFLICTS_WITH => 'fieldThree', ['string']],
+                    'fieldTwo' => [['string']],
+                    'fieldThree' => [FilterOptions::CONFLICTS_WITH => 'fieldOne', ['string']],
+                ],
+                'input' => [
+                    'fieldOne' => 'abc',
+                    'fieldTwo' => '123',
+                    'fieldThree' => 'xyz',
+                ],
+                'options' => [],
+                'result' => [
+                    false,
+                    null,
+                    "Field 'fieldOne' cannot be given if field 'fieldThree' is present.\n"
+                    . "Field 'fieldThree' cannot be given if field 'fieldOne' is present.",
+                    [],
+                ],
+            ],
+            'conflicts with multiple' => [
+                'spec' => [
+                    'fieldOne' => [FilterOptions::CONFLICTS_WITH => ['fieldTwo', 'fieldThree'], ['string']],
+                    'fieldTwo' => [['string']],
+                    'fieldThree' => [['string']],
+                ],
+                'input' => [
+                    'fieldOne' => 'abc',
+                    'fieldTwo' => '123',
+                ],
+                'options' => [],
+                'result' => [
+                    false,
+                    null,
+                    "Field 'fieldOne' cannot be given if field 'fieldTwo' is present.",
+                    [],
+                ],
+            ],
+            'conflicts with not present' => [
+                'spec' => [
+                    'fieldOne' => [FilterOptions::CONFLICTS_WITH => 'fieldThree', ['string']],
+                    'fieldTwo' => [['string']],
+                ],
+                'input' => [
+                    'fieldOne' => 'abc',
+                    'fieldTwo' => '123',
+                ],
+                'options' => [],
+                'result' => [
+                    true,
+                    [
+                        'fieldOne' => 'abc',
+                        'fieldTwo' => '123',
+                    ],
+                    null,
+                    [],
+                ],
+            ],
         ];
     }