10000 [Validator] Added error codes to all constraints with multiple error … · symfony/symfony@7c76ac3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7c76ac3

Browse files
webmozartwebmozart
committed
[Validator] Added error codes to all constraints with multiple error causes
1 parent 69deac3 commit 7c76ac3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+842
-219
lines changed

‎src/Symfony/Component/Form/Extension/Validator/Constraints/Form.php

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,20 @@
1818
*/
1919
class Form extends Constraint
2020
{
21+
const ERROR_NOT_SYNCHRONIZED = 1;
22+
const ERROR_NO_SUCH_FIELD = 2;
23+
2124
/**
22-
* Violation code marking an invalid form.
25+
* @deprecated Deprecated since Symfony 2.6, to be removed in 3.0. Use
26+
* {@self ERROR_NOT_SYNCHRONIZED} instead.
2327
*/
2428
const ERR_INVALID = 1;
2529

30+
protected static $errorNames = array(
31+
self::ERROR_NOT_SYNCHRONIZED => 'ERROR_NOT_SYNCHRONIZED',
32+
self::ERROR_NO_SUCH_FIELD => 'ERROR_NO_SUCH_FIELD',
33+
);
34+
2635
/**
2736
* {@inheritdoc}
2837
*/

‎src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php

Lines changed: 2 additions & 1 deletion
117
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public function validate($form, Constraint $constraint)
102102
$this->buildViolation($config->getOption('invalid_message'))
103103
->setParameters(array_replace(array('{{ value }}' => $clientDataAsString), $config->getOption('invalid_message_parameters')))
104104
->setInvalidValue($form->getViewData())
105-
->setCode(Form::ERR_INVALID)
105+
->setCode(Form::ERROR_NOT_SYNCHRONIZED)
106106
->addViolation();
107107
}
108108
}
@@ -112,6 +112,7 @@ public function validate($form, Constraint $constraint)
112112
$this->buildViolation($config->getOption('extra_fields_message'))
113113
->setParameter('{{ extra_fields }}', implode('", "', array_keys($form->getExtraData())))
114114
->setInvalidValue($form->getExtraData())
115+
->setCode(Form::ERROR_NO_SUCH_FIELD)
115116
->addViolation();
116117
}
118
}

‎src/Symfony/Component/Form/Extension/Validator/EventListener/ValidationListener.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public function validateForm(FormEvent $event)
6666
foreach ($violations as $violation) {
6767
// Allow the "invalid" constraint to be put onto
6868
// non-synchronized forms
69-
$allowNonSynchronized = Form::ERR_INVALID === $violation->getCode();
69+
$allowNonSynchronized = $violation->getConstraint() instanceof Form && Form::ERROR_NOT_SYNCHRONIZED === $violation->getCode();
7070

7171
$this->violationMapper->mapViolation($violation, $form, $allowNonSynchronized);
7272
}

‎src/Symfony/Component/Form/Tests/Extension/Validator/Constraints/FormValidatorTest.php

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ function () { throw new TransformationFailedException(); }
229229
->setParameter('{{ value }}', 'foo')
230230
->setParameter('{{ foo }}', 'bar')
231231
->setInvalidValue('foo')
232-
->setCode(Form::ERR_INVALID)
232+
->setCode(Form::ERROR_NOT_SYNCHRONIZED)
233233
->assertRaised();
234234
}
235235

@@ -263,7 +263,7 @@ function () { throw new TransformationFailedException(); }
263263
->setParameter('{{ value }}', 'foo')
264264
->setParameter('{{ foo }}', 'bar')
265265
->setInvalidValue('foo')
266-
->setCode(Form::ERR_INVALID)
266+
->setCode(Form::ERROR_NOT_SYNCHRONIZED)
267267
->assertRaised();
268268
}
269269

@@ -296,7 +296,7 @@ function () { throw new TransformationFailedException(); }
296296
$this->buildViolation('invalid_message_key')
297297
->setParameter('{{ value }}', 'foo')
298298
->setInvalidValue('foo')
299-
->setCode(Form::ERR_INVALID)
299+
->setCode(Form::ERROR_NOT_SYNCHRONIZED)
300300
->assertRaised();
301301
}
302302

@@ -549,9 +549,11 @@ public function testViolationIfExtraData()
549549

550550
$this->validator->validate($form, new Form());
551551

552-
$this->assertViolation('Extra!', array(
553-
'{{ extra_fields }}' => 'foo',
554-
), 'property.path', array('foo' => 'bar'));
552+
$this->buildViolation('Extra!')
553+
->setParameter('{{ extra_fields }}', 'foo')
554+
->setInvalidValue(array('foo' => 'bar'))
555+
->setCode(Form::ERROR_NO_SUCH_FIELD)
556+
->assertRaised();
555557
}
556558

557559
public function testNoViolationIfAllowExtraData()

‎src/Symfony/Component/Form/Tests/Extension/Validator/EventListener/ValidationListenerTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ protected function setUp()
6666

6767
private function getConstraintViolation($code = null)
6868
{
69-
return new ConstraintViolation($this->message, $this->messageTemplate, $this->params, null, 'prop.path', null, null, $code);
69+
return new ConstraintViolation($this->message, $this->messageTemplate, $this->params, null, 'prop.path', null, null, $code, new Form());
7070
}
7171

7272
private function getBuilder($name = 'name', $propertyPath = null, $dataClass = null)
@@ -109,7 +109,7 @@ public function testMapViolation()
109109

110110
public function testMapViolationAllowsNonSyncIfInvalid()
111111
{
112-
$violation = $this->getConstraintViolation(Form::ERR_INVALID);
112+
$violation = $this->getConstraintViolation(Form::ERROR_NOT_SYNCHRONIZED);
113113
$form = $this->getForm('street');
114114

115115
$this->validator->expects($this->once())

‎src/Symfony/Component/Validator/Constraint.php

Lines changed: 29 additions & 0 deletions
< 10000 td data-grid-cell-id="diff-eadef5e494fbfb85346e70992f4b18994df0b999b7d336c9cece5ab9e9a4a18a-58-65-2" data-line-anchor="diff-eadef5e494fbfb85346e70992f4b18994df0b999b7d336c9cece5ab9e9a4a18aR65" data-selected="false" role="gridcell" style="background-color:var(--bgColor-default);padding-right:24px" tabindex="-1" valign="top" class="focusable-grid-cell diff-text-cell right-side-diff-cell left-side">

Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Symfony\Component\Validator;
1313

1414
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
15+
use Symfony\Component\Validator\Exception\InvalidArgumentException;
1516
use Symfony\Component\Validator\Exception\InvalidOptionsException;
1617
use Symfony\Component\Validator\Exception\MissingOptionsException;
1718

@@ -50,12 +51,40 @@ abstract class Constraint
5051
*/
5152
const PROPERTY_CONSTRAINT = 'property';
5253

54+
/**
55+
* Maps error codes to the names of their constants
56+
* @var array
57+
*/
58+
protected static $errorNames = array();
59+
5360
/**
5461
* Domain-specific data attached to a constraint
5562
* @var mixed
5663
*/
5764
public $payload;
5865
66+
/**
67+
* Returns the name of the given error code.
68+
*
69+
* @param int $errorCode The error code
70+
*
71+
* @return string The name of the error code
72+
*
73+
* @throws InvalidArgumentException If the error code does not exist
74+
*/
75+
public static function getErrorName($errorCode)
76+
{
77+
if (!isset(static::$errorNames[$errorCode])) {
78+
throw new InvalidArgumentException(sprintf(
79+
'The error code "%s" does not exist for constraint of type "%s".',
80+
$errorCode,
81+
get_called_class()
82+
));
83+
}
84+
85+
return static::$errorNames[$errorCode];
86+
}
87+
5988
/**
6089
* Initializes the constraint with options.
6190
*

‎src/Symfony/Component/Validator/Constraints/CardScheme.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,18 @@
2020
* @Target({"PROPERTY", "METHOD", "ANNOTATION"})
2121
*
2222
* @author Tim Nagel <t.nagel@infinite.net.au>
23+
* @author Bernhard Schussek <bschussek@gmail.com>
2324
*/
2425
class CardScheme extends Constraint
2526
{
27+
const ERROR_NOT_NUMERIC = 1;
28+
const ERROR_INVALID_FORMAT = 2;
29+
30+
protected static $errorNames = array(
31+
self::ERROR_NOT_NUMERIC => 'ERROR_NOT_NUMERIC',
32+
self::ERROR_INVALID_FORMAT => 'ERROR_INVALID_FORMAT',
33+
);
34+
2635
public $message = 'Unsupported card type or invalid card number.';
2736
public $schemes;
2837

‎src/Symfony/Component/Validator/Constraints/CardSchemeValidator.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ public function validate($value, Constraint $constraint)
117117
if (!is_numeric($value)) {
118118
$this->buildViolation($constraint->message)
119119
->setParameter('{{ value }}', $this->formatValue($value))
120+
->setCode(CardScheme::ERROR_NOT_NUMERIC)
120121
->addViolation();
121122

122123
return;
@@ -135,6 +136,7 @@ public function validate($value, Constraint $constraint)
135136

136137
$this->buildViolation($constraint->message)
137138
->setParameter('{{ value }}', $this->formatValue($value))
139+
->setCode(CardScheme::ERROR_INVALID_FORMAT)
138140
->addViolation();
139141
}
140142
}

‎src/Symfony/Component/Validator/Constraints/Choice.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@
2323
*/
2424
class Choice extends Constraint
2525
{
26+
const ERROR_NO_SUCH_CHOICE = 1;
27+
const ERROR_TOO_FEW = 2;
28+
const ERROR_TOO_MANY = 3;
29+
30+
protected static $errorNames = array(
31+
self::ERROR_NO_SUCH_CHOICE => 'ERROR_NO_SUCH_CHOICE',
32+
self::ERROR_TOO_FEW => 'ERROR_TOO_FEW',
33+
self::ERROR_TOO_MANY => 'ERROR_TOO_MANY',
34+
);
35+
2636
public $choices;
2737
public $callback;
2838
public $multiple = false;

‎src/Symfony/Component/Validator/Constraints/ChoiceValidator.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ public function validate($value, Constraint $constraint)
6565
if (!in_array($_value, $choices, $constraint->strict)) {
6666
$this->buildViolation($constraint->multipleMessage)
6767
->setParameter('{{ value }}', $this->formatValue($_value))
68+
->setCode(Choice::ERROR_NO_SUCH_CHOICE)
6869
->setInvalidValue($_value)
6970
->addViolation();
7071

@@ -78,6 +79,7 @@ public function validate($value, Constraint $constraint)
7879
$this->buildViolation($constraint->minMessage)
7980
->setParameter('{{ limit }}', $constraint->min)
8081
->setPlural((int) $constraint->min)
82+
->setCode(Choice::ERROR_TOO_FEW)
8183
->addViolation();
8284

8385
return;
@@ -87,13 +89,15 @@ public function validate($value, Constraint $constraint)
8789
$this->buildViolation($constraint->maxMessage)
8890
->setParameter('{{ limit }}', $constraint->max)
8991
->setPlural((int) $constraint->max)
92+
->setCode(Choice::ERROR_TOO_MANY)
9093
->addViolation();
9194

9295
return;
9396
}
9497
} elseif (!in_array($value, $choices, $constraint->strict)) {
9598
$this->buildViolation($constraint->message)
9699
->setParameter('{{ value }}', $this->formatValue($value))
100+
->setCode(Choice::ERROR_NO_SUCH_CHOICE)
97101
->addViolation();
98102
}
99103
}

‎src/Symfony/Component/Validator/Constraints/Collection.php

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111

1212
namespace Symfony\Component\Validator\Constraints;
1313

14-
use Symfony\Component\Validator\Constraint;
1514
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
1615

1716
/**
@@ -24,6 +23,14 @@
2423
*/
2524
class Collection extends Composite
2625
{
26+
const ERROR_MISSING_FIELD = 1;
27+
const ERROR_NO_SUCH_FIELD = 2;
28+
29+
protected static $errorNames = array(
30+
self::ERROR_MISSING_FIELD => 'ERROR_MISSING_FIELD',
31+
self::ERROR_NO_SUCH_FIELD => 'ERROR_NO_SUCH_FIELD',
32+
);
33+
2734
public $fields = array();
2835
public $allowExtraFields = false;
2936
public $allowMissingFields = false;

‎src/Symfony/Component/Validator/Constraints/CollectionValidator.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ public function validate($value, Constraint $constraint)
7373
->atPath('['.$field.']')
7474
->setParameter('{{ field }}', $this->formatValue($field))
7575
->setInvalidValue(null)
76+
->setCode(Collection::ERROR_MISSING_FIELD)
7677
->addViolation();
7778
}
7879
}
@@ -84,6 +85,7 @@ public function validate($value, Constraint $constraint)
8485
->atPath('['.$field.']')
8586
->setParameter('{{ field }}', $this->formatValue($field))
8687
->setInvalidValue($fieldValue)
88+
->setCode(Collection::ERROR_NO_SUCH_FIELD)
8789
->addViolation();
8890
}
8991
}

‎src/Symfony/Component/Validator/Constraints/Count.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@
2424
*/
2525
class Count extends Constraint
2626
{
27+
const ERROR_TOO_FEW = 1;
28+
const ERROR_TOO_MANY = 2;
29+
30+
protected static $errorNames = array(
31+
self::ERROR_TOO_FEW => 'ERROR_TOO_FEW',
32+
self::ERROR_TOO_MANY => 'ERROR_TOO_MANY',
33+
);
34+
2735
public $minMessage = 'This collection should contain {{ limit }} element or more.|This collection should contain {{ limit }} elements or more.';
2836
public $maxMessage = 'This collection should contain {{ limit }} element or less.|This collection should contain {{ limit }} elements or less.';
2937
public $exactMessage = 'This collection should contain exactly {{ limit }} element.|This collection should contain exactly {{ limit }} elements.';

‎src/Symfony/Component/Validator/Constraints/CountValidator.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public function validate($value, Constraint $constraint)
4141
->setParameter('{{ limit }}', $constraint->max)
4242
->setInvalidValue($value)
4343
->setPlural((int) $constraint->max)
44+
->setCode(Count::ERROR_TOO_MANY)
4445
->addViolation();
4546

4647
return;
@@ -52,6 +53,7 @@ public function validate($value, Constraint $constraint)
5253
->setParameter('{{ limit }}', $constraint->min)
5354
->setInvalidValue($value)
5455
->setPlural((int) $constraint->min)
56+
->setCode(Count::ERROR_TOO_FEW)
5557
->addViolation();
5658
}
5759
}

‎src/Symfony/Component/Validator/Constraints/Date.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,13 @@
2323
*/
2424
class Date extends Constraint
2525
{
26+
const ERROR_INVALID_FORMAT = 1;
27+
const ERROR_INVALID_DATE = 2;
28+
29+
protected static $errorNames = array(
30+
self::ERROR_INVALID_FORMAT => 'ERROR_INVALID_FORMAT',
31+
self::ERROR_INVALID_DATE => 'ERROR_INVALID_DATE',
32+
);
33+
2634
public $message = 'This value is not a valid date.';
2735
}

‎src/Symfony/Component/Validator/Constraints/DateTime.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,15 @@
2323
*/
2424
class DateTime extends Constraint
2525
{
26+
const ERROR_INVALID_FORMAT = 1;
27+
const ERROR_INVALID_DATE = 2;
28+
const ERROR_INVALID_TIME = 3;
29+
30+
protected static $errorNames = array(
31+
self::ERROR_INVALID_FORMAT => 'ERROR_INVALID_FORMAT',
32+
self::ERROR_INVALID_DATE => 'ERROR_INVALID_DATE',
33+
self::ERROR_INVALID_TIME => 'ERROR_INVALID_TIME',
34+
);
35+
2636
public $message = 'This value is not a valid datetime.';
2737
}

‎src/Symfony/Component/Validator/Constraints/DateTimeValidator.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public function validate($value, Constraint $constraint)
4545
if (!preg_match(static::PATTERN, $value, $matches)) {
4646
$this->buildViolation($constraint->message)
4747
->setParameter('{{ value }}', $this->formatValue($value))
48+
->setCode(DateTime::ERROR_INVALID_FORMAT)
4849
->addViolation();
4950

5051
return;
@@ -53,12 +54,14 @@ public function validate($value, Constraint $constraint)
5354
if (!DateValidator::checkDate($matches[1], $matches[2], $matches[3])) {
5455
$this->buildViolation($constraint->message)
5556
->setParameter('{{ value }}', $this->formatValue($value))
57+
->setCode(DateTime::ERROR_INVALID_DATE)
5658
->addViolation();
5759
}
5860

5961
if (!TimeValidator::checkTime($matches[4], $matches[5], $matches[6])) {
6062
$this->buildViolation($constraint->message)
6163
->setParameter('{{ value }}', $this->formatValue($value))
64+
->setCode(DateTime::ERROR_INVALID_TIME)
6265
->addViolation();
6366
}
6467
}

‎src/Symfony/Component/Validator/Constraints/DateValidator.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ public function validate($value, Constraint $constraint)
6262
if (!preg_match(static::PATTERN, $value, $matches)) {
6363
$this->buildViolation($constraint->message)
6464
->setParameter('{{ value }}', $this->formatValue($value))
65+
->setCode(Date::ERROR_INVALID_FORMAT)
6566
->addViolation();
6667

6768
return;
@@ -70,6 +71,7 @@ public function validate($value, Constraint $constraint)
7071
if (!self::checkDate($matches[1], $matches[2], $matches[3])) {
7172
$this->buildViolation($constraint->message)
7273
->setParameter('{{ value }}', $this->formatValue($value))
74+
->setCode(Date::ERROR_INVALID_DATE)
7375
->addViolation();
7476
}
7577
}

‎src/Symfony/Component/Validator/Constraints/Email.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@
2323
*/
2424
class Email extends Constraint
2525
{
26+
const ERROR_INVALID_FORMAT = 1;
27+
const ERROR_MX_CHECK_FAILED = 2;
28+
const ERROR_HOST_CHECK_FAILED = 3;
29+
30+
protected static $errorNames = array(
31+
self::ERROR_INVALID_FORMAT => 'ERROR_STRICT_CHECK_FAILED',
32+
self::ERROR_MX_CHECK_FAILED => 'ERROR_MX_CHECK_FAILED',
33+
self::ERROR_HOST_CHECK_FAILED => 'ERROR_HOST_CHECK_FAILED',
34+
);
35+
2636
public $message = 'This value is not a valid email address.';
2737
public $checkMX = false;
2838
public $checkHost = false;

0 commit comments

Comments
 (0)
0