1. interface
  2. Symfony
  3. Component
  4. Validator
  5. Violation
  6. 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

ConstraintViolationBuilderInterface
atPath(string $path)

Stores the property path at which the violation should be generated.

ConstraintViolationBuilderInterface
setParameter(string $key, string $value)

Sets a parameter to be inserted into the violation message.

ConstraintViolationBuilderInterface
setParameters(array $parameters)

Sets all parameters to be inserted into the violation message.

ConstraintViolationBuilderInterface
setTranslationDomain(string $translationDomain)

Sets the translation domain which should be used for translating the violation message.

ConstraintViolationBuilderInterface
setInvalidValue(mixed $invalidValue)

Sets the invalid value that caused this violation.

ConstraintViolationBuilderInterface
setPlural(int $number)

Sets the number which determines how the plural form of the violation message is chosen when it is translated.

ConstraintViolationBuilderInterface
setCode(string|null $code)

Sets the violation code.

ConstraintViolationBuilderInterface
setCause(mixed $cause)

Sets the cause of the violation.

addViolation()

Adds the violation to the current execution context.

Details

at line line 38
ConstraintViolationBuilderInterface 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

ConstraintViolationBuilderInterface This builder

at line line 48
ConstraintViolationBuilderInterface 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

ConstraintViolationBuilderInterface This builder

at line line 59
ConstraintViolationBuilderInterface 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

ConstraintViolationBuilderInterface This builder

at line line 71
ConstraintViolationBuilderInterface setTranslationDomain(string $translationDomain)

Sets the translation domain which should be used for translating the violation message.

Parameters

string $translationDomain The translation domain

Return Value

ConstraintViolationBuilderInterface This builder

See also

\Symfony\Component\Translation\TranslatorInterface

at line line 80
ConstraintViolationBuilderInterface setInvalidValue(mixed $invalidValue)

Sets the invalid value that caused this violation.

Parameters

mixed $invalidValue The invalid value

Return Value

ConstraintViolationBuilderInterface This builder

at line line 92
ConstraintViolationBuilderInterface 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

ConstraintViolationBuilderInterface This builder

See also

\Symfony\Component\Translation\TranslatorInterface::transChoice()

at line line 101
ConstraintViolationBuilderInterface setCode(string|null $code)

Sets the violation code.

Parameters

string|null $code The violation code

Return Value

ConstraintViolationBuilderInterface This builder

at line line 110
ConstraintViolationBuilderInterface setCause(mixed $cause)

Sets the cause of the violation.

Parameters

mixed $cause The cause of the violation

Return Value

ConstraintViolationBuilderInterface This builder

at line line 115
addViolation()

Adds the violation to the current execution context.