1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Validator
  7. \
  8. Violation
  9. \
  10. ConstraintViolationBuilderInterface

ConstraintViolationBuilderInterface

interface ConstraintViolationBuilderInterface

Builds {@link \Symfony\Component\Validator\ConstraintViolationInterface} objects.

Use the various methods on this interface to configure the built violation. Finally, call {@link addViolation()} to add the violation to the current execution context.

Methods

$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

$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

See also

$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

See also

$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.