Add RequiredArrayKeys validation attribute

spatie · Oct 2, 2023 · 5018f10 · 5018f10
1 parent 03812ba
commit 5018f10
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 0 deletions.
diff --git a/docs/advanced-usage/validation-attributes.md b/docs/advanced-usage/validation-attributes.md
@@ -794,6 +794,21 @@ public ?string $closure;
 public ?string $closure; 
 ```
 
+### RequiredArrayKeys
+
+[Docs](https://laravel.com/docs/9.x/validation#rule-required-array-keys)
+
+```php
+#[RequiredArrayKeys('a')]
+public array $closure;
+
+#[RequiredArrayKeys(['a', 'b'])]
+public array $closure;
+
+#[RequiredArrayKeys('a', 'b')]
+public array $closure;
+```
+
 ### Rule
 
 ```php

diff --git a/src/Attributes/Validation/RequiredArrayKeys.php b/src/Attributes/Validation/RequiredArrayKeys.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Spatie\LaravelData\Attributes\Validation;
+
+use Attribute;
+use Illuminate\Support\Arr;
+use Spatie\LaravelData\Support\Validation\References\RouteParameterReference;
+
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_PARAMETER)]
+class RequiredArrayKeys extends StringValidationAttribute
+{
+ protected string|array $values;
+
+ public function __construct(string|array|RouteParameterReference ...$values)
+ {
+ $this->values = Arr::flatten($values);
+ }
+
+ public static function keyword(): string
+ {
+ return 'required_array_keys';
+ }
+
+ public function parameters(): array
+ {
+ return [$this->values];
+ }
+}
diff --git a/src/Support/Validation/ValidationRuleFactory.php b/src/Support/Validation/ValidationRuleFactory.php
@@ -66,6 +66,7 @@
 use Spatie\LaravelData\Attributes\Validation\Prohibits;
 use Spatie\LaravelData\Attributes\Validation\Regex;
 use Spatie\LaravelData\Attributes\Validation\Required;
+use Spatie\LaravelData\Attributes\Validation\RequiredArrayKeys;
 use Spatie\LaravelData\Attributes\Validation\RequiredIf;
 use Spatie\LaravelData\Attributes\Validation\RequiredUnless;
 use Spatie\LaravelData\Attributes\Validation\RequiredWith;
@@ -165,6 +166,7 @@ protected function mapping(): array
  Prohibits::keyword() => Prohibits::class,
  Regex::keyword() => Regex::class,
  Required::keyword() => Required::class,
+ RequiredArrayKeys::keyword() => RequiredArrayKeys::class,
  RequiredIf::keyword() => RequiredIf::class,
  RequiredUnless::keyword() => RequiredUnless::class,
  RequiredWith::keyword() => RequiredWith::class,

diff --git a/tests/Datasets/Attributes/RulesDataset.php b/tests/Datasets/Attributes/RulesDataset.php
@@ -69,6 +69,7 @@
 use Spatie\LaravelData\Attributes\Validation\Prohibits;
 use Spatie\LaravelData\Attributes\Validation\Regex;
 use Spatie\LaravelData\Attributes\Validation\Required;
+use Spatie\LaravelData\Attributes\Validation\RequiredArrayKeys;
 use Spatie\LaravelData\Attributes\Validation\RequiredIf;
 use Spatie\LaravelData\Attributes\Validation\RequiredUnless;
 use Spatie\LaravelData\Attributes\Validation\RequiredWith;
@@ -126,6 +127,7 @@ function fixature(
  yield from prohibitedIfAttributes();
  yield from prohibitedUnlessAttributes();
  yield from prohibitsAttributes();
+ yield from requiredArrayKeysAttributes();
  yield from requiredIfAttributes();
  yield from requiredUnlessAttributes();
  yield from requiredWithAttributes();
@@ -845,6 +847,24 @@ function prohibitsAttributes(): Generator
  );
 }
 
+function requiredArrayKeysAttributes(): Generator
+{
+ yield fixature(
+ attribute: new RequiredArrayKeys('x'),
+ expected: 'required_array_keys:x',
+ );
+
+ yield fixature(
+ attribute: new RequiredArrayKeys(['x', 'y']),
+ expected: 'required_array_keys:x,y',
+ );
+
+ yield fixature(
+ attribute: new RequiredArrayKeys('x', 'y'),
+ expected: 'required_array_keys:x,y',
+ );
+}
+
 function requiredIfAttributes(): Generator
 {
  yield fixature(