Skip to content

[8.x] Add array_keys validation rule #40720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 1, 2022
Merged

[8.x] Add array_keys validation rule #40720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5586994
Add contains all validation rule to assert an array or string contain…
Drewdan Jan 30, 2022
3c80ebd
lint
Drewdan Jan 31, 2022
d125f98
styleci lint changes
Drewdan Jan 31, 2022
d669be0
rename rule to array_keys and made rule fail when not an array
Drewdan Jan 31, 2022
5c635a9
lint
Drewdan Jan 31, 2022
97428de
Update ReplacesAttributes.php
taylorotwell Feb 1, 2022
8b0c4c6
Update ValidatesAttributes.php
taylorotwell Feb 1, 2022
4fccefb
formatting
taylorotwell Feb 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/Illuminate/Validation/Concerns/ReplacesAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,24 @@ protected function replaceInArray($message, $attribute, $rule, $parameters)
return str_replace(':other', $this->getDisplayableAttribute($parameters[0]), $message);
}

/**
* Replace all place-holders for the required_array_keys rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredArrayKeys($message, $attribute, $rule, $parameters)
{
foreach ($parameters as &$parameter) {
$parameter = $this->getDisplayableValue($attribute, $parameter);
}

return str_replace(':values', implode(', ', $parameters), $message);
}

/**
* Replace all place-holders for the mimetypes rule.
*
Expand Down
23 changes: 23 additions & 0 deletions src/Illuminate/Validation/Concerns/ValidatesAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,29 @@ public function validateArray($attribute, $value, $parameters = [])
return empty(array_diff_key($value, array_fill_keys($parameters, '')));
}

/**
* Validate that an array has all of the given keys.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
public function validateRequiredArrayKeys($attribute, $value, $parameters)
{
if (! is_array($value)) {
return false;
}

foreach ($parameters as $param) {
if (! Arr::exists($value, $param)) {
return false;
}
}

return true;
}

/**
* Validate the size of an attribute is between a set of values.
*
Expand Down
97 changes: 97 additions & 0 deletions tests/Validation/ValidationValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7019,6 +7019,103 @@ public function testFailOnFirstError()
$this->assertEquals($expectedFailOnFirstErrorEnableResult, $failOnFirstErrorEnable->getMessageBag()->getMessages());
}

public function testArrayKeysValidationPassedWhenHasKeys()
{
$trans = $this->getIlluminateArrayTranslator();

$data = [
'baz' => [
'foo' => 'bar',
'fee' => 'faa',
'laa' => 'lee',
],
];

$rules = [
'baz' => [
'array',
'required_array_keys:foo,fee,laa',
],
];

$validator = new Validator($trans, $data, $rules, [], []);
$this->assertTrue($validator->passes());
}

public function testArrayKeysValidationPassedWithPartialMatch()
{
$trans = $this->getIlluminateArrayTranslator();

$data = [
'baz' => [
'foo' => 'bar',
'fee' => 'faa',
'laa' => 'lee',
],
];

$rules = [
'baz' => [
'array',
'required_array_keys:foo,fee',
],
];

$validator = new Validator($trans, $data, $rules, [], []);
$this->assertTrue($validator->passes());
}

public function testArrayKeysValidationFailsWithMissingKey()
{
$trans = $this->getIlluminateArrayTranslator();
$trans->addLines(['validation.required_array_keys' => 'The :attribute field must contain entries for :values'], 'en');

$data = [
'baz' => [
'foo' => 'bar',
'fee' => 'faa',
'laa' => 'lee',
],
];

$rules = [
'baz' => [
'array',
'required_array_keys:foo,fee,boo,bar',
],
];

$validator = new Validator($trans, $data, $rules, [], []);
$this->assertFalse($validator->passes());
$this->assertSame(
'The baz field must contain entries for foo, fee, boo, bar',
$validator->messages()->first('baz')
);
}

public function testArrayKeysValidationFailsWithNotAnArray()
{
$trans = $this->getIlluminateArrayTranslator();
$trans->addLines(['validation.required_array_keys' => 'The :attribute field must contain entries for :values'], 'en');

$data = [
'baz' => 'no an array',
];

$rules = [
'baz' => [
'required_array_keys:foo,fee,boo,bar',
],
];

$validator = new Validator($trans, $data, $rules, [], []);
$this->assertFalse($validator->passes());
$this->assertSame(
'The baz field must contain entries for foo, fee, boo, bar',
$validator->messages()->first('baz')
);
}

protected function getTranslator()
{
return m::mock(TranslatorContract::class);
Expand Down