ConstraintViolationBuilder
class ConstraintViolationBuilder implements ConstraintViolationBuilderInterface
Default implementation of {@link ConstraintViolationBuilderInterface}.
Methods
__construct(ConstraintViolationList $violations, Constraint $constraint, $message, array $parameters, $root, $propertyPath, $invalidValue, TranslatorInterface $translator, $translationDomain = null) | ||
$this | atPath(string $path) Stores the property path at which the violation should be generated. | |
$this | setParameter(string $key, string $value) Sets a parameter to be inserted into the violation message. | |
$this | setParameters(array $parameters) Sets all parameters to be inserted into the violation message. | |
$this | setTranslationDomain(string $translationDomain) Sets the translation domain which should be used for translating the violation message. | |
$this | setInvalidValue(mixed $invalidValue) Sets the invalid value that caused this violation. | |
$this | setPlural(int $number) Sets the number which determines how the plural form of the violation message is chosen when it is translated. | |
$this | setCode(string|null $code) Sets the violation code. | |
$this | setCause(mixed $cause) Sets the cause of the violation. | |
addViolation() Adds the violation to the current execution context. |
Details
__construct(ConstraintViolationList $violations, Constraint $constraint, $message, array $parameters, $root, $propertyPath, $invalidValue, TranslatorInterface $translator, $translationDomain = null)
Parameters
ConstraintViolationList | $violations | |
Constraint | $constraint | |
$message | ||
array | $parameters | |
$root | ||
$propertyPath | ||
$invalidValue | ||
TranslatorInterface | $translator | |
$translationDomain |
$this atPath(string $path)
Stores the property path at which the violation should be generated.
The passed path will be appended to the current property path of the execution context.
Parameters
string | $path | The property path |
Return Value
$this |
$this setParameter(string $key, string $value)
Sets a parameter to be inserted into the violation message.
Parameters
string | $key | The name of the parameter |
string | $value | The value to be inserted in the parameter's place |
Return Value
$this |
$this setParameters(array $parameters)
Sets all parameters to be inserted into the violation message.
Parameters
array | $parameters | An array with the parameter names as keys and the values to be inserted in their place as values |
Return Value
$this |
$this setTranslationDomain(string $translationDomain)
Sets the translation domain which should be used for translating the violation message.
Parameters
string | $translationDomain | The translation domain |
Return Value
$this |
$this setInvalidValue(mixed $invalidValue)
Sets the invalid value that caused this violation.
Parameters
mixed | $invalidValue | The invalid value |
Return Value
$this |
$this setPlural(int $number)
Sets the number which determines how the plural form of the violation message is chosen when it is translated.
Parameters
int | $number | The number for determining the plural form |
Return Value
$this |
$this setCode(string|null $code)
Sets the violation code.
Parameters
string|null | $code | The violation code |
Return Value
$this |
$this setCause(mixed $cause)
Sets the cause of the violation.
Parameters
mixed | $cause | The cause of the violation |
Return Value
$this |
addViolation()
Adds the violation to the current execution context.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Validator/Violation/ConstraintViolationBuilder.html