Constraint (Component\Validator)
Symfony\Component\Validator\Constraint
abstract class Constraint
Contains the properties of a constraint definition.
A constraint can be defined on a class, an option or a getter method. The Constraint class encapsulates all the configuration required for validating this class, option or getter result successfully.
Constraint instances are immutable and serializable.
Constants
DEFAULT_GROUP | The name of the group given to all constraints with no explicit group. |
CLASS_CONSTRAINT | Marks a constraint that can be put onto classes. |
PROPERTY_CONSTRAINT | Marks a constraint that can be put onto properties. |
Properties
mixed | $payload | Domain-specific data attached to a constraint. |
array | $groups | array$groupsThe groups that the constraint belongs to |
Methods
static string | getErrorName(int $errorCode) Returns the name of the given error code. | |
__construct(mixed $options = null) Initializes the constraint with options. | ||
__set(string $option, mixed $value) Sets the value of a lazily initialized option. | ||
mixed | __get(string $option) Returns the value of a lazily initialized option. | |
addImplicitGroupName(string $group) Adds the given group if this constraint is in the Default group. | ||
string | getDefaultOption() Returns the name of the default option. | |
array | getRequiredOptions() Returns the name of the required options. | |
string | validatedBy() Returns the name of the class that validates this constraint. | |
string|array | getTargets() Returns whether the constraint can be put onto classes, properties or both. | |
array | __sleep() Optimizes the serialized value to minimize storage space. |
Details
static public string getErrorName(int $errorCode)
Returns the name of the given error code.
public __construct(mixed $options = null)
Initializes the constraint with options.
You should pass an associative array. The keys should be the names of existing properties in this class. The values should be the value for these properties.
Alternatively you can override the method getDefaultOption() to return the name of an existing property. If no associative array is passed, this property is set instead.
You can force that certain options are set by overriding getRequiredOptions() to return the names of these options. If any option is not set here, an exception is thrown.
public __set(string $option, mixed $value)
Sets the value of a lazily initialized option.
Corresponding properties are added to the object on first access. Hence this method will be called at most once per constraint instance and option name.
public mixed __get(string $option)
Returns the value of a lazily initialized option.
Corresponding properties are added to the object on first access. Hence this method will be called at most once per constraint instance and option name.
public addImplicitGroupName(string $group)
Adds the given group if this constraint is in the Default group.
public string getDefaultOption()
Returns the name of the default option.
Override this method to define a default option.
public array getRequiredOptions()
Returns the name of the required options.
Override this method if you want to define required options.
public string validatedBy()
Returns the name of the class that validates this constraint.
By default, this is the fully qualified name of the constraint class suffixed with "Validator". You can override this method to change that behaviour.
public string|array getTargets()
Returns whether the constraint can be put onto classes, properties or both.
This method should return one or more of the constants Constraint::CLASSCONSTRAINT and Constraint::PROPERTYCONSTRAINT.
public array __sleep()
Optimizes the serialized value to minimize storage space.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Validator/Constraint.html