8000 [Validator] Allow single constraint to be passed to the `constraints` option of the `When` constraint by alexandre-daubois · Pull Request #50425 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Validator] Allow single constraint to be passed to the constraints option of the When constraint #50425

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 1 commit into from
Jun 21, 2023
Merged

[Validator] Allow single constraint to be passed to the constraints option of the When constraint #50425

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
1 change: 1 addition & 0 deletions src/Symfony/Component/Validator/CHANGELOG.md
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ CHANGELOG
---

* Allow single integer for the `versions` option of the `Uuid` constraint
* Allow single constraint to be passed to the `constraints` option of the `When` constraint

6.3
---
Expand Down
8 changes: 7 additions & 1 deletion src/Symfony/Component/Validator/Constraints/When.php
View file
Open in desktop
< 8000 td id="diff-276913baa48a57302fb2fb9fa9616d86bd53a2af0ee81ba14494617e164d8c54L20" data-line-number="20" class="blob-num blob-num-context js-linkable-line-number">
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@

use Symfony\Component\ExpressionLanguage\Expression;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Exception\LogicException;

/**
* @Annotation
*
* @Target({"CLASS", "PROPERTY", "METHOD", "ANNOTATION"})
*/
#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
Expand All @@ -26,7 +28,7 @@ class When extends Composite
public $constraints = [];
public $values = [];

public function __construct(string|Expression|array $expression, array $constraints = null, array $values = null, array $groups = null, $payload = null, array $options = [])
public function __construct(string|Expression|array $expression, array|Constraint $constraints = null, array $values = null, array $groups = null, $payload = null, array $options = [])
{
if (!class_exists(ExpressionLanguage::class)) {
throw new LogicException(sprintf('The "symfony/expression-language" component is required to use the "%s" constraint. Try running "composer require symfony/expression-language".', __CLASS__));
Expand All @@ -39,6 +41,10 @@ public function __construct(string|Expression|array $expression, array $constrai
$options['constraints'] = $constraints;
}

if (isset($options['constraints']) && !\is_array($options['constraints'])) {
$options['constraints'] = [$options['constraints']];
}

if (null !== $groups) {
$options['groups'] = $groups;
}
Expand Down
3 changes: 3 additions & 0 deletions src/Symfony/Component/Validator/Tests/Constraints/Fixtures/WhenTestWithAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ class WhenTestWithAttributes
], groups: ['foo'])]
private $bar;

#[When(expression: 'true', constraints: new NotNull(), groups: ['foo'])]
private $qux;

#[When(expression: 'true', constraints: [
new NotNull(),
new NotBlank(),
Expand Down
27 changes: 27 additions & 0 deletions src/Symfony/Component/Validator/Tests/Constraints/WhenTest.php
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ public function testAnnotations()
], $barConstraint->constraints);
self::assertSame(['foo'], $barConstraint->groups);

[$quxConstraint] = $metadata->properties['qux']->getConstraints();

self::assertInstanceOf(When::class, $quxConstraint);
self::assertSame('true', $quxConstraint->expression);
self::assertEquals([
new NotNull([
'groups' => ['foo'],
]),
], $quxConstraint->constraints);
self::assertSame(['foo'], $quxConstraint->groups);

[$bazConstraint] = $metadata->getters['baz']->getConstraints();

self::assertInstanceOf(When::class, $bazConstraint);
Expand Down Expand Up @@ -152,6 +163,17 @@ public function testAttributes()
], $barConstraint->constraints);
self::assertSame(['foo'], $barConstraint->groups);

[$quxConstraint] = $metadata->properties['qux']->getConstraints();

self::assertInstanceOf(When::class, $quxConstraint);
self::assertSame('true', $quxConstraint->expression);
self::assertEquals([
new NotNull([
'groups' => ['foo'],
]),
], $quxConstraint->constraints);
self::assertSame(['foo'], $quxConstraint->groups);

[$bazConstraint] = $metadata->getters['baz']->getConstraints();

self::assertInstanceOf(When::class, $bazConstraint);
Expand Down Expand Up @@ -183,6 +205,11 @@ class WhenTestWithAnnotations
*/
private $bar;

/**
* @When(expression="true", constraints=@NotNull, groups={"foo"})
*/
private $qux;

/**
* @When(expression="true", constraints={@NotNull, @NotBlank})
*/
Expand Down
11 changes: 11 additions & 0 deletions src/Symfony/Component/Validator/Tests/Constraints/WhenValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ public function testConstraintsAreExecuted()
]));
}

public function testConstraintIsExecuted()
{
$constraint = new NotNull();
$this->expectValidateValue(0, 'Foo', [$constraint]);

$this->validator->validate('Foo', new When([
'expression' => 'true',
'constraints' => $constraint,
]));
}

public function testConstraintsAreExecutedWithNull()
{
$constraints = [
Expand Down
0