[10.x] Feat: Add color_hex validation rule (#49056)

* Add color_hex validation rule * fix: styleci * formatting --------- Co-authored-by: Taylor Otwell <[email protected]>
laravel · Nov 20, 2023 · 85fcda7 · 85fcda7
1 parent 5f103f0
commit 85fcda7
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/src/Illuminate/Translation/lang/en/validation.php b/src/Illuminate/Translation/lang/en/validation.php
@@ -66,6 +66,7 @@
         'numeric' => 'The :attribute field must be greater than or equal to :value.',
         'string' => 'The :attribute field must be greater than or equal to :value characters.',
     ],
+    'hex_color' => 'The :attribute field must be a valid hexadecimal color.',
     'image' => 'The :attribute field must be an image.',
     'in' => 'The selected :attribute is invalid.',
     'in_array' => 'The :attribute field must exist in :other.',

diff --git a/src/Illuminate/Validation/Concerns/ValidatesAttributes.php b/src/Illuminate/Validation/Concerns/ValidatesAttributes.php
@@ -1270,6 +1270,18 @@ public function validateUppercase($attribute, $value, $parameters)
         return Str::upper($value) === $value;
     }
 
+    /**
+     * Validate that an attribute is a valid HEX color.
+     *
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function validateHexColor($attribute, $value)
+    {
+        return preg_match('/^#(?:[0-9a-fA-F]{3}){1,2}$/', $value) === 1;
+    }
+
     /**
      * Validate the MIME type of a file is an image MIME type.
      *

diff --git a/tests/Validation/ValidationValidatorTest.php b/tests/Validation/ValidationValidatorTest.php
@@ -1925,6 +1925,19 @@ public function testValidateInArray()
         $this->assertSame('The value of foo.2 does not exist in bar.*.', $v->messages()->first('foo.2'));
     }
 
+    public function testValidateHexColor()
+    {
+        $trans = $this->getIlluminateArrayTranslator();
+        $v = new Validator($trans, ['color'=> '#FFFFFF'], ['color'=>'hex_color']);
+        $this->assertTrue($v->passes());
+        $v = new Validator($trans, ['color'=> '#FFF'], ['color'=>'hex_color']);
+        $this->assertTrue($v->passes());
+        $v = new Validator($trans, ['color'=> '#GGG'], ['color'=>'hex_color']);
+        $this->assertFalse($v->passes());
+        $v = new Validator($trans, ['color'=> '#GGGGGGG'], ['color'=>'hex_color']);
+        $this->assertFalse($v->passes());
+    }
+
     public function testValidateConfirmed()
     {
         $trans = $this->getIlluminateArrayTranslator();