Email
extends Constraint
in package
Contains the properties of a constraint definition.
Tags
Table of Contents
- CLASS_CONSTRAINT = 'class'
- Marks a constraint that can be put onto classes.
- DEFAULT_GROUP = 'Default'
- The name of the group given to all constraints with no explicit group.
- HOST_CHECK_FAILED_ERROR = '7da53a8b-56f3-4288-bb3e-ee9ede4ef9a1'
- INVALID_FORMAT_ERROR = 'bd79c0ab-ddba-46cc-a703-a7a4b08de310'
- MX_CHECK_FAILED_ERROR = 'bf447c1c-0266-4e10-9c6c-573df282e413'
- PROPERTY_CONSTRAINT = 'property'
- Marks a constraint that can be put onto properties.
- VALIDATION_MODE_HTML5 = 'html5'
- VALIDATION_MODE_LOOSE = 'loose'
- VALIDATION_MODE_STRICT = 'strict'
- $checkHost : mixed
- $checkMX : mixed
- $groups : array<string|int, string>
- The groups that the constraint belongs to.
- $message : mixed
- $mode : mixed
- $normalizer : mixed
- $payload : mixed
- Domain-specific data attached to a constraint.
- $strict : mixed
- $errorNames : mixed
- Maps error codes to the names of their constants.
- __construct() : mixed
- Initializes the constraint with options.
- __isset() : bool
- __set() : mixed
- Sets the value of a lazily initialized option.
- addImplicitGroupName() : mixed
- Adds the given group if this constraint is in the Default group.
- getDefaultOption() : string|null
- Returns the name of the default option.
- getErrorName() : string
- Returns the name of the given error code.
- getRequiredOptions() : array<string|int, string>
- Returns the name of the required options.
- getTargets() : string|array<string|int, string>
- Returns whether the constraint can be put onto classes, properties or both.
- validatedBy() : string
- Returns the name of the class that validates this constraint.
Constants
CLASS_CONSTRAINT
Marks a constraint that can be put onto classes.
public
mixed
CLASS_CONSTRAINT
= 'class'
DEFAULT_GROUP
The name of the group given to all constraints with no explicit group.
public
mixed
DEFAULT_GROUP
= 'Default'
HOST_CHECK_FAILED_ERROR
public
mixed
HOST_CHECK_FAILED_ERROR
= '7da53a8b-56f3-4288-bb3e-ee9ede4ef9a1'
Tags
INVALID_FORMAT_ERROR
public
mixed
INVALID_FORMAT_ERROR
= 'bd79c0ab-ddba-46cc-a703-a7a4b08de310'
MX_CHECK_FAILED_ERROR
public
mixed
MX_CHECK_FAILED_ERROR
= 'bf447c1c-0266-4e10-9c6c-573df282e413'
Tags
PROPERTY_CONSTRAINT
Marks a constraint that can be put onto properties.
public
mixed
PROPERTY_CONSTRAINT
= 'property'
VALIDATION_MODE_HTML5
public
mixed
VALIDATION_MODE_HTML5
= 'html5'
VALIDATION_MODE_LOOSE
public
mixed
VALIDATION_MODE_LOOSE
= 'loose'
VALIDATION_MODE_STRICT
public
mixed
VALIDATION_MODE_STRICT
= 'strict'
Properties
$checkHost
public
mixed
$checkHost
= false
Tags
$checkMX
public
mixed
$checkMX
= false
Tags
$groups
The groups that the constraint belongs to.
public
array<string|int, string>
$groups
$message
public
mixed
$message
= 'This value is not a valid email address.'
$mode
public
mixed
$mode
$normalizer
public
mixed
$normalizer
$payload
Domain-specific data attached to a constraint.
public
mixed
$payload
$strict
public
mixed
$strict
Tags
$errorNames
Maps error codes to the names of their constants.
protected
static mixed
$errorNames
= [self::INVALID_FORMAT_ERROR => 'STRICT_CHECK_FAILED_ERROR', self::MX_CHECK_FAILED_ERROR => 'MX_CHECK_FAILED_ERROR', self::HOST_CHECK_FAILED_ERROR => 'HOST_CHECK_FAILED_ERROR']
Methods
__construct()
Initializes the constraint with options.
public
__construct([mixed $options = null ]) : mixed
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.
Parameters
- $options : mixed = null
-
The options (as associative array) or the value for the default option (any other type)
Return values
mixed —__isset()
public
__isset(string $option) : bool
Parameters
- $option : string
-
The option name
Return values
bool —__set()
Sets the value of a lazily initialized option.
public
__set(string $option, mixed $value) : mixed
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.
Parameters
- $option : string
-
The option name
- $value : mixed
-
The value to set
Tags
Return values
mixed —addImplicitGroupName()
Adds the given group if this constraint is in the Default group.
public
addImplicitGroupName(string $group) : mixed
Parameters
- $group : string
Return values
mixed —getDefaultOption()
Returns the name of the default option.
public
getDefaultOption() : string|null
Override this method to define a default option.
Tags
Return values
string|null —getErrorName()
Returns the name of the given error code.
public
static getErrorName(string $errorCode) : string
Parameters
- $errorCode : string
-
The error code
Tags
Return values
string —The name of the error code
getRequiredOptions()
Returns the name of the required options.
public
getRequiredOptions() : array<string|int, string>
Override this method if you want to define required options.
Tags
Return values
array<string|int, string> —getTargets()
Returns whether the constraint can be put onto classes, properties or both.
public
getTargets() : string|array<string|int, string>
This method should return one or more of the constants Constraint::CLASS_CONSTRAINT and Constraint::PROPERTY_CONSTRAINT.
Return values
string|array<string|int, string> —One or more constant values
validatedBy()
Returns the name of the class that validates this constraint.
public
validatedBy() : string
By default, this is the fully qualified name of the constraint class suffixed with "Validator". You can override this method to change that behavior.