Skip to content

[Validator] use named arguments to configure validation constraints #21635

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

Open
xabbuh wants to merge 1 commit into
base: 7.4
Choose a base branch
from
Open

[Validator] use named arguments to configure validation constraints #21635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 23 additions & 17 deletions reference/constraints/Collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ following:
'personal_email' => new Assert\Email(),
'short_bio' => [
new Assert\NotBlank(),
new Assert\Length([
'max' => 100,
'maxMessage' => 'Your short bio is too long!',
]),
new Assert\Length(
max: 100,
maxMessage: 'Your short bio is too long!',
),
],
],
allowMissingFields: true,
Expand Down Expand Up @@ -196,13 +196,13 @@ you can do the following:
{
#[Assert\Collection(
fields: [
'personal_email' => new Assert\Required([
'personal_email' => new Assert\Required(constraints: [
new Assert\NotBlank,
new Assert\Email,
]),
'alternate_email' => new Assert\Optional(
'alternate_email' => new Assert\Optional(constraints: [
new Assert\Email
),
]),
],
)]
protected array $profileData = ['personal_email' => 'email@example.com'];
Expand All @@ -218,11 +218,13 @@ you can do the following:
fields:
personal_email:
- Required:
- NotBlank: ~
- Email: ~
constraints:
- NotBlank: ~
- Email: ~
alternate_email:
- Optional:
- Email: ~
constraints:
- Email: ~

.. code-block:: xml

Expand All @@ -238,13 +240,17 @@ you can do the following:
<option name="fields">
<value key="personal_email">
<constraint name="Required">
<constraint name="NotBlank"/>
<constraint name="Email"/>
<option name="constraints">
<constraint name="NotBlank"/>
<constraint name="Email"/>
</option>
</constraint>
</value>
<value key="alternate_email">
<constraint name="Optional">
<constraint name="Email"/>
<option name="constraints">
<constraint name="Email"/>
</option>
</constraint>
</value>
</option>
Expand All @@ -269,11 +275,11 @@ you can do the following:
{
$metadata->addPropertyConstraint('profileData', new Assert\Collection(
fields: [
'personal_email' => new Assert\Required([
'personal_email' => new Assert\Required(constraints: [
new Assert\NotBlank(),
new Assert\Email(),
]),
'alternate_email' => new Assert\Optional(new Assert\Email()),
'alternate_email' => new Assert\Optional(constraints: [new Assert\Email()]),
],
));
}
Expand All @@ -293,8 +299,8 @@ groups. Take the following example::

$constraint = new Assert\Collection(
fields: [
'name' => new Assert\NotBlank(['groups' => 'basic']),
'email' => new Assert\NotBlank(['groups' => 'contact']),
'name' => new Assert\NotBlank(groups: ['basic']),
'email' => new Assert\NotBlank(groups: ['contact']),
],
);

Expand Down
22 changes: 11 additions & 11 deletions validation/raw_values.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,22 +67,22 @@ Validation of arrays is possible using the ``Collection`` constraint::

$groups = new Assert\GroupSequence(['Default', 'custom']);

$constraint = new Assert\Collection([
$constraint = new Assert\Collection(fields: [
// the keys correspond to the keys in the input array
'name' => new Assert\Collection([
'first_name' => new Assert\Length(['min' => 101]),
'last_name' => new Assert\Length(['min' => 1]),
'name' => new Assert\Collection(fields: [
'first_name' => new Assert\Length(min: 101),
'last_name' => new Assert\Length(min: 1),
]),
'email' => new Assert\Email(),
'simple' => new Assert\Length(['min' => 102]),
'simple' => new Assert\Length(min: 102),
'eye_color' => new Assert\Choice(choices: [3, 4]),
'file' => new Assert\File(),
'password' => new Assert\Length(['min' => 60]),
'tags' => new Assert\Optional([
new Assert\Type('array'),
new Assert\Count(['min' => 1]),
'password' => new Assert\Length(min: 60),
'tags' => new Assert\Optional(constraints: [
new Assert\Type(type: 'array'),
new Assert\Count(min: 1),
new Assert\All([
new Assert\Collection([
new Assert\Collection(constraints: [
'slug' => [
new Assert\NotBlank(),
new Assert\Type(['type' => 'string']),
Expand All @@ -91,7 +91,7 @@ Validation of arrays is possible using the ``Collection`` constraint::
new Assert\NotBlank(),
],
]),
new CustomUniqueTagValidator(['groups' => 'custom']),
new CustomUniqueTagValidator(groups: ['custom']),
]),
]),
]);
Expand Down