Skip to content
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

[8.x] Add key/index/iteration placeholders to validation attributes #35754

Closed
wants to merge 3 commits into from
Closed

[8.x] Add key/index/iteration placeholders to validation attributes #35754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a37f95e
Add key placeholder to validation attributes
amir9480 Dec 29, 2020
8709319
Merge branch '8.x' of https://github.com/laravel/framework into add_i…
amir9480 Dec 29, 2020
e229a9f
Add replaceArrayPlaceholders function
amir9480 Jan 3, 2021
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
48 changes: 48 additions & 0 deletions src/Illuminate/Validation/Concerns/FormatsMessages.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public function makeReplacements($message, $attribute, $rule, $parameters)
$message, $this->getDisplayableAttribute($attribute)
);

$message = $this->replaceArrayPlaceholders($message, $attribute);
$message = $this->replaceInputPlaceholder($message, $attribute);

if (isset($this->replacers[Str::snake($rule)])) {
Expand Down Expand Up @@ -295,6 +296,53 @@ protected function replaceAttributePlaceholder($message, $value)
);
}

/**
* Replace the array attribute :key{n}/:index{n}/:iteration{n} placeholders in the given message.
*
* @param string $message
* @param string $attribute
* @return string
*/
protected function replaceArrayPlaceholders($message, $attribute)
{
$explicitKeys = $this->getExplicitKeys($attribute);

if (count($explicitKeys) > 0) {
foreach ($explicitKeys as $explicitKeyIndex => $explicitKey) {
$message = str_replace(
[":key$explicitKeyIndex", ":KEY$explicitKeyIndex", ":Key$explicitKeyIndex"],
[$explicitKey, Str::upper($explicitKey), Str::ucfirst($explicitKey)],
$message
);

if (is_numeric($explicitKey)) {
$message = str_replace(
[":index$explicitKeyIndex", ":iteration$explicitKeyIndex"],
[$explicitKey, intval($explicitKey) + 1],
$message
);
}
}

$firstKey = $explicitKeys[0];
$message = str_replace(
[':key', ':KEY', ':Key'],
[$firstKey, Str::upper($firstKey), Str::ucfirst($firstKey)],
$message
);

if (is_numeric($firstKey)) {
$message = str_replace(
[':index', ':iteration'],
[$firstKey, intval($firstKey) + 1],
$message
);
}
}

return $message;
}

/**
* Replace the :input placeholder in the given message.
*
Expand Down
64 changes: 64 additions & 0 deletions tests/Validation/ValidationValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,70 @@ public function testAttributeNamesAreReplacedInArrays()
$this->assertSame('First name is required!', $v->messages()->first('names.0'));
}

public function testKeyIsReplaced()
{
$trans = $this->getIlluminateArrayTranslator();
$trans->addLines([
'validation.required' => ':attribute is required!',
'validation.attributes.name.*' => 'Any name(:key)',
'validation.attributes.name_nested.*.*' => 'Any name(:key0)(:key1)',
], 'en');
$v = new Validator($trans, ['name' => ['', 'Foo', '']], ['name.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(0) is required!', $v->messages()->first('name.0'));
$this->assertSame('Any name(2) is required!', $v->messages()->first('name.2'));

$v = new Validator($trans, ['name_nested' => [['en' => 'Foo', 'fa' => ''], ['en' => '', 'fa' => 'Bar']]], ['name_nested.*.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(0)(fa) is required!', $v->messages()->first('name_nested.0.fa'));
$this->assertSame('Any name(1)(en) is required!', $v->messages()->first('name_nested.1.en'));
}

public function testIndexIsReplaced()
{
$trans = $this->getIlluminateArrayTranslator();
$trans->addLines([
'validation.required' => ':attribute is required!',
'validation.attributes.name.*' => 'Any name(:index)',
'validation.attributes.name_nested.*.*' => 'Any name(:index0)(:index1)',
], 'en');
$v = new Validator($trans, ['name' => ['', 'Foo', '']], ['name.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(0) is required!', $v->messages()->first('name.0'));
$this->assertSame('Any name(2) is required!', $v->messages()->first('name.2'));

$v = new Validator($trans, ['name_nested' => [['', 'Foo'], ['Bar', '']]], ['name_nested.*.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(0)(0) is required!', $v->messages()->first('name_nested.0.0'));
$this->assertSame('Any name(1)(1) is required!', $v->messages()->first('name_nested.1.1'));
}

public function testIterationIsReplaced()
{
$trans = $this->getIlluminateArrayTranslator();
$trans->addLines([
'validation.required' => ':attribute is required!',
'validation.attributes.name.*' => 'Any name(:iteration)',
'validation.attributes.name_nested.*.*' => 'Any name(:iteration0)(:iteration1)',
], 'en');
$v = new Validator($trans, ['name' => ['', 'Foo', '']], ['name.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(1) is required!', $v->messages()->first('name.0'));
$this->assertSame('Any name(3) is required!', $v->messages()->first('name.2'));

$v = new Validator($trans, ['name_nested' => [['', 'Foo'], ['Bar', '', '']]], ['name_nested.*.*' => 'required']);
$this->assertFalse($v->passes());
$v->messages()->setFormat(':message');
$this->assertSame('Any name(1)(1) is required!', $v->messages()->first('name_nested.0.0'));
$this->assertSame('Any name(2)(2) is required!', $v->messages()->first('name_nested.1.1'));
$this->assertSame('Any name(2)(3) is required!', $v->messages()->first('name_nested.1.2'));
}

public function testInputIsReplaced()
{
$trans = $this->getIlluminateArrayTranslator();
Expand Down