Merge pull request #79 from chadicus/master

Allow value placeholder in custom error messages

Author: chadicus

README.md

@@ -107,6 +107,8 @@ The filter specification for a single field is also an array.  It can contain tw
   `defaultRequired` option.
 * `default` defines what the default value of this field is if none is given.  A field with a default value will be guaranteed to be in the
   result.  The `required` value does not affect `default` behavior.
+* `error` defines a custom error message to be returned if the value fails filtering. Within the error string, `{value}` can be used as a placeholder
+  for the value that failed filtering.
 
 The rest of the specification for the field are the filters to apply.
 

src/Filterer.php

@@ -379,14 +379,13 @@ private static function handleCustomError(
         $error = $customError;
         if ($error === null) {
             $error = sprintf(
-                "Field '%s' with value '%s' failed filtering, message '%s'",
+                "Field '%s' with value '{value}' failed filtering, message '%s'",
                 $field,
-                trim(var_export($value, true), "'"),
                 $e->getMessage()
             );
         }
 
-        $errors[] = $error;
+        $errors[] = str_replace('{value}', trim(var_export($value, true), "'"), $error);
         return $errors;
     }
 

tests/FiltererTest.php

@@ -417,6 +417,26 @@ public function filterWithCustomError()
         );
     }
 
+    /**
+     * @test
+     * @covers ::filter
+     */
+    public function filterWithCustomErrorContainingValuePlaceholder()
+    {
+        $result = Filterer::filter(
+            [
+                'fieldOne' => [
+                    'error' => "The value '{value}' is invalid.",
+                    ['uint'],
+                ],
+            ],
+            ['fieldOne' => 'abc']
+        );
+        $this->assertSame(
+            [false, null, "The value 'abc' is invalid.", []],
+            $result
+        );
+    }
     /**
      * Verify behavior of filter() when 'error' is not a string value.
      *