IdenticalToValidator
extends AbstractComparisonValidator
in package
Validates values are identical (===).
Tags
Table of Contents
- OBJECT_TO_STRING = 2
- Whether to cast objects with a "__toString()" method to strings.
- PRETTY_DATE = 1
- Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").
- $context : ExecutionContextInterface
- $propertyAccessor : mixed
- __construct() : mixed
- initialize() : mixed
- Initializes the constraint validator.
- validate() : mixed
- {@inheritdoc}
- compareValues() : bool
- Compares the two given values to find if their relationship is valid.
- formatTypeOf() : string
- Returns a string representation of the type of the value.
- formatValue() : string
- Returns a string representation of the value.
- formatValues() : string
- Returns a string representation of a list of values.
- getErrorCode() : string|null
- Returns the error code used if the comparison fails.
- getPropertyAccessor() : PropertyAccessorInterface
Constants
OBJECT_TO_STRING
Whether to cast objects with a "__toString()" method to strings.
public
mixed
OBJECT_TO_STRING
= 2
PRETTY_DATE
Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").
public
mixed
PRETTY_DATE
= 1
Properties
$context
protected
ExecutionContextInterface
$context
$propertyAccessor
private
mixed
$propertyAccessor
Methods
__construct()
public
__construct([PropertyAccessorInterface $propertyAccessor = null ]) : mixed
Parameters
- $propertyAccessor : PropertyAccessorInterface = null
Return values
mixed —initialize()
Initializes the constraint validator.
public
initialize(ExecutionContextInterface $context) : mixed
Parameters
- $context : ExecutionContextInterface
Return values
mixed —validate()
{@inheritdoc}
public
validate(mixed $value, Constraint $constraint) : mixed
Parameters
- $value : mixed
- $constraint : Constraint
Return values
mixed —compareValues()
Compares the two given values to find if their relationship is valid.
protected
compareValues(mixed $value1, mixed $value2) : bool
Parameters
- $value1 : mixed
-
The first value to compare
- $value2 : mixed
-
The second value to compare
Return values
bool —true if the relationship is valid, false otherwise
formatTypeOf()
Returns a string representation of the type of the value.
protected
formatTypeOf(mixed $value) : string
This method should be used if you pass the type of a value as message parameter to a constraint violation. Note that such parameters should usually not be included in messages aimed at non-technical people.
Parameters
- $value : mixed
-
The value to return the type of
Return values
string —The type of the value
formatValue()
Returns a string representation of the value.
protected
formatValue(mixed $value, int $format) : string
This method returns the equivalent PHP tokens for most scalar types (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped in double quotes ("). Objects, arrays and resources are formatted as "object", "array" and "resource". If the $format bitmask contains the PRETTY_DATE bit, then objects will be formatted with the . If it is not available, they will be formatted as RFC-3339 dates ("Y-m-d H:i:s").
Be careful when passing message parameters to a constraint violation that (may) contain objects, arrays or resources. These parameters should only be displayed for technical users. Non-technical users won't know what an "object", "array" or "resource" is and will be confused by the violation message.
Parameters
- $value : mixed
-
The value to format as string
- $format : int
-
A bitwise combination of the format constants in this class
Return values
string —The string representation of the passed value
formatValues()
Returns a string representation of a list of values.
protected
formatValues(array<string|int, mixed> $values, int $format) : string
Each of the values is converted to a string using . The values are then concatenated with commas.
Parameters
- $values : array<string|int, mixed>
-
A list of values
- $format : int
-
A bitwise combination of the format constants in this class
Tags
Return values
string —The string representation of the value list
getErrorCode()
Returns the error code used if the comparison fails.
protected
getErrorCode() : string|null
Return values
string|null —The error code or null if no code should be set
getPropertyAccessor()
private
getPropertyAccessor() : PropertyAccessorInterface