Added validation rules contains, extensions and hex_color. (#7313)

Author: weslenteche

publish/en/validation.php

@@ -41,6 +41,7 @@
     ],
     'boolean' => 'The :attribute field must be true or false.',
     'confirmed' => 'The :attribute confirmation does not match.',
+    'contains' => 'The :attribute is missing a required value.',
     'date' => 'The :attribute is not a valid date.',
     'date_equals' => 'The :attribute must be a date equal to :date.',
     'date_format' => 'The :attribute does not match the format :format.',
@@ -56,7 +57,9 @@
     'doesnt_start_with' => 'The :attribute must not start with one of the following: :values.',
     'email' => 'The :attribute must be a valid email address.',
     'ends_with' => 'The :attribute must end with one of the following: :values.',
+    'enum' => 'The selected :attribute is invalid.',
     'exists' => 'The selected :attribute is invalid.',
+    'extensions' => 'The :attribute must have one of the following extensions: :values.',
     'file' => 'The :attribute must be a file.',
     'filled' => 'The :attribute field is required.',
     'gt' => [
@@ -71,6 +74,7 @@
         'string' => 'The :attribute must be great than or equal to :value characters',
         'array' => 'The :attribute must be great than or equal to :value items',
     ],
+    'hex_color' => 'The :attribute must be a valid hexadecimal color.',
     'image' => 'The :attribute must be an image.',
     'in' => 'The selected :attribute is invalid.',
     'in_array' => 'The :attribute field does not exist in :other.',
@@ -93,6 +97,7 @@
         'string' => 'The :attribute must be less than or equal to :value characters',
         'array' => 'The :attribute must be less than or equal to :value items',
     ],
+    'mac_address' => 'The :attribute must be a valid MAC address.',
     'max' => [
         'numeric' => 'The :attribute may not be greater than :max.',
         'file' => 'The :attribute may not be greater than :max kilobytes.',

src/Concerns/ReplacesAttributes.php

@@ -94,6 +94,14 @@ protected function replaceDigitsBetween(string $message, string $attribute, stri
         return $this->replaceBetween($message, $attribute, $rule, $parameters);
     }
 
+    /**
+     * Replace all place-holders for the extensions rule.
+     */
+    protected function replaceExtensions(string $message, string $attribute, string $rule, array $parameters): string
+    {
+        return str_replace(':values', implode(', ', $parameters), $message);
+    }
+
     /**
      * Replace all place-holders for the min rule.
      */

src/Concerns/ValidatesAttributes.php

@@ -322,6 +322,27 @@ public function validateConfirmed(string $attribute, $value): bool
         return $this->validateSame($attribute, $value, [$attribute . '_confirmation']);
     }
 
+    /**
+     * Validate an attribute contains a list of values.
+     *
+     * @param mixed $value
+     * @param array<int, int|string> $parameters
+     */
+    public function validateContains(string $attribute, $value, array $parameters): bool
+    {
+        if (! is_array($value)) {
+            return false;
+        }
+
+        foreach ($parameters as $parameter) {
+            if (! in_array($parameter, $value)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     /**
      * Validate that an attribute is a valid date.
      *
@@ -635,6 +656,25 @@ public function guessColumnForQuery(string $attribute): string
         return $attribute;
     }
 
+    /**
+     * Validate the extension of a file upload attribute is in a set of defined extensions.
+     *
+     * @param mixed $value
+     * @param array<int, int|string> $parameters
+     */
+    public function validateExtensions(string $attribute, $value, array $parameters): bool
+    {
+        if (! $this->isValidFileInstance($value)) {
+            return false;
+        }
+
+        if ($this->shouldBlockPhpUpload($value, $parameters)) {
+            return false;
+        }
+
+        return in_array(strtolower($value->getExtension()), $parameters);
+    }
+
     /**
      * Validate the given value is a valid file.
      *
@@ -791,6 +831,16 @@ public function validateUppercase(string $attribute, mixed $value, array $parame
         return Str::upper($value) === $value;
     }
 
+    /**
+     * Validate that an attribute is a valid HEX color.
+     *
+     * @param mixed $value
+     */
+    public function validateHexColor(string $attribute, $value): bool
+    {
+        return preg_match('/^#(?:(?:[0-9a-f]{3}){1,2}|(?:[0-9a-f]{4}){1,2})$/i', $value) === 1;
+    }
+
     /**
      * Validate the MIME type of a file is an image MIME type.
      *

src/Rules/File.php

@@ -43,6 +43,13 @@ class File implements Rule, DataAwareRule, ValidatorAwareRule
      */
     protected array $allowedMimetypes = [];
 
+    /**
+     * The extensions that the given file should match.
+     *
+     * @var array
+     */
+    protected $allowedExtensions = [];
+
     /**
      * The minimum size in kilobytes that the file can be.
      */
@@ -124,6 +131,19 @@ public static function types(array|string $mimetypes): static
         return \Hyperf\Tappable\tap(new static(), fn ($file) => $file->allowedMimetypes = (array) $mimetypes);
     }
 
+    /**
+     * Limit the uploaded file to the given file extensions.
+     *
+     * @param array<int, string>|string $extensions
+     * @return $this
+     */
+    public function extensions($extensions): static
+    {
+        $this->allowedExtensions = (array) $extensions;
+
+        return $this;
+    }
+
     /**
      * Indicate that the uploaded file should be exactly a certain size in kilobytes.
      *
@@ -276,6 +296,10 @@ protected function buildValidationRules()
 
         $rules = array_merge($rules, $this->buildMimetypes());
 
+        if (! empty($this->allowedExtensions)) {
+            $rules[] = 'extensions:' . implode(',', array_map('strtolower', $this->allowedExtensions));
+        }
+
         $rules[] = match (true) {
             is_null($this->minimumFileSize) && is_null($this->maximumFileSize) => null,
             is_null($this->maximumFileSize) => "min:{$this->minimumFileSize}",

src/Validator.php

@@ -128,8 +128,8 @@ class Validator implements ValidatorContract
      * The validation rules that may be applied to files.
      */
     protected array $fileRules = [
-        'File', 'Image', 'Mimes', 'Mimetypes', 'Min',
-        'Max', 'Size', 'Between', 'Dimensions',
+        'Between', 'Dimensions', 'Extensions', 'File', 'Image',
+        'Max', 'Mimes', 'Mimetypes', 'Min', 'Size',
     ];
 
     /**

tests/Cases/ValidationFileRuleTest.php

@@ -133,6 +133,52 @@ public function testMixOfMimetypesAndMimes()
         );
     }
 
+    public function testSingleExtension()
+    {
+        $this->fails(
+            File::default()->extensions('png'),
+            (new FileFactory())->createWithContent('foo', file_get_contents(__DIR__ . '/fixtures/image.png')),
+            ['validation.extensions']
+        );
+
+        $this->fails(
+            File::default()->extensions('png'),
+            (new FileFactory())->createWithContent('foo.jpg', file_get_contents(__DIR__ . '/fixtures/image.png')),
+            ['validation.extensions']
+        );
+
+        $this->fails(
+            File::default()->extensions('jpeg'),
+            (new FileFactory())->createWithContent('foo.jpg', file_get_contents(__DIR__ . '/fixtures/image.png')),
+            ['validation.extensions']
+        );
+
+        $this->passes(
+            File::default()->extensions('png'),
+            (new FileFactory())->createWithContent('foo.png', file_get_contents(__DIR__ . '/fixtures/image.png')),
+        );
+    }
+
+    public function testMultipleExtensions()
+    {
+        $this->fails(
+            File::default()->extensions(['png', 'jpeg', 'jpg']),
+            (new FileFactory())->createWithContent('foo', file_get_contents(__DIR__ . '/fixtures/image.png')),
+            ['validation.extensions']
+        );
+
+        $this->fails(
+            File::default()->extensions(['png', 'jpeg']),
+            (new FileFactory())->createWithContent('foo.jpg', file_get_contents(__DIR__ . '/fixtures/image.png')),
+            ['validation.extensions']
+        );
+
+        $this->passes(
+            File::default()->extensions(['png', 'jpeg', 'jpg']),
+            (new FileFactory())->createWithContent('foo.png', file_get_contents(__DIR__ . '/fixtures/image.png')),
+        );
+    }
+
     public function testImage()
     {
         $this->fails(