class AbstractComparisonValidator
Provides a base class for the validation of property comparisons.
@author Daniel Holmes <daniel@danielholmes.org> @author Bernhard Schussek <bschussek@gmail.com>
Hierarchy
- class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
- class \Symfony\Component\Validator\Constraints\AbstractComparisonValidator extends \Symfony\Component\Validator\ConstraintValidator
Expanded class hierarchy of AbstractComparisonValidator
File
-
vendor/
symfony/ validator/ Constraints/ AbstractComparisonValidator.php, line 29
Namespace
Symfony\Component\Validator\ConstraintsView source
abstract class AbstractComparisonValidator extends ConstraintValidator {
public function __construct(?PropertyAccessorInterface $propertyAccessor = null) {
}
public function validate(mixed $value, Constraint $constraint) : void {
if (!$constraint instanceof AbstractComparison) {
throw new UnexpectedTypeException($constraint, AbstractComparison::class);
}
if (null === $value) {
return;
}
if ($path = $constraint->propertyPath) {
if (null === ($object = $this->context
->getObject())) {
return;
}
try {
$comparedValue = $this->getPropertyAccessor()
->getValue($object, $path);
} catch (NoSuchPropertyException $e) {
throw new ConstraintDefinitionException(\sprintf('Invalid property path "%s" provided to "%s" constraint: ', $path, get_debug_type($constraint)) . $e->getMessage(), 0, $e);
} catch (UninitializedPropertyException) {
$comparedValue = null;
}
}
else {
$comparedValue = $constraint->value;
}
// Convert strings to date-time objects if comparing to another date-time object
// This allows to compare with any date/time value supported by date-time constructors:
// https://php.net/datetime.formats
if (\is_string($comparedValue) && $value instanceof \DateTimeInterface) {
try {
$comparedValue = new $value($comparedValue);
} catch (\Exception) {
throw new ConstraintDefinitionException(\sprintf('The compared value "%s" could not be converted to a "%s" instance in the "%s" constraint.', $comparedValue, get_debug_type($value), get_debug_type($constraint)));
}
}
if (!$this->compareValues($value, $comparedValue)) {
$violationBuilder = $this->context
->buildViolation($constraint->message)
->setParameter('{{ value }}', $this->formatValue($value, self::OBJECT_TO_STRING | self::PRETTY_DATE))
->setParameter('{{ compared_value }}', $this->formatValue($comparedValue, self::OBJECT_TO_STRING | self::PRETTY_DATE))
->setParameter('{{ compared_value_type }}', $this->formatTypeOf($comparedValue))
->setCode($this->getErrorCode());
if (null !== $path) {
$violationBuilder->setParameter('{{ compared_value_path }}', $path);
}
$violationBuilder->addViolation();
}
}
private function getPropertyAccessor() : PropertyAccessorInterface {
return $this->propertyAccessor ??= PropertyAccess::createPropertyAccessor();
}
/**
* Compares the two given values to find if their relationship is valid.
*/
protected abstract function compareValues(mixed $value1, mixed $value2) : bool;
/**
* Returns the error code used if the comparison fails.
*/
protected function getErrorCode() : ?string {
return null;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AbstractComparisonValidator::compareValues | abstract protected | function | Compares the two given values to find if their relationship is valid. | 9 | |
AbstractComparisonValidator::getErrorCode | protected | function | Returns the error code used if the comparison fails. | 9 | |
AbstractComparisonValidator::getPropertyAccessor | private | function | |||
AbstractComparisonValidator::validate | public | function | Checks if the passed value is valid. | Overrides ConstraintValidatorInterface::validate | |
AbstractComparisonValidator::__construct | public | function | |||
ConstraintValidator::$context | protected | property | |||
ConstraintValidator::formatTypeOf | protected | function | Returns a string representation of the type of the value. | ||
ConstraintValidator::formatValue | protected | function | Returns a string representation of the value. | ||
ConstraintValidator::formatValues | protected | function | Returns a string representation of a list of values. | ||
ConstraintValidator::initialize | public | function | Initializes the constraint validator. | Overrides ConstraintValidatorInterface::initialize | |
ConstraintValidator::OBJECT_TO_STRING | public | constant | Whether to cast objects with a "__toString()" method to strings. | ||
ConstraintValidator::PRETTY_DATE | public | constant | 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"). |