abstract class AbstractComparisonValidator in Zircon Profile 8

Provides a base class for the validation of property comparisons.

@author Daniel Holmes <[e-mail]> @author Bernhard Schussek <[e-mail]>

Hierarchy

• class \Symfony\Component\Validator\ConstraintValidator implements ConstraintValidatorInterface
  • class \Symfony\Component\Validator\Constraints\AbstractComparisonValidator

File

vendor/symfony/validator/Constraints/AbstractComparisonValidator.php, line 25

Namespace

Symfony\Component\Validator\Constraints

abstract class AbstractComparisonValidator extends ConstraintValidator {

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof AbstractComparison) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\AbstractComparison');
    }
    if (null === $value) {
      return;
    }
    $comparedValue = $constraint->value;

    // Convert strings to DateTimes if comparing another DateTime
    // This allows to compare with any date/time value supported by
    // the DateTime constructor:
    // http://php.net/manual/en/datetime.formats.php
    if (is_string($comparedValue)) {
      if ($value instanceof \DatetimeImmutable) {

        // If $value is immutable, convert the compared value to a
        // DateTimeImmutable too
        $comparedValue = new \DatetimeImmutable($comparedValue);
      }
      elseif ($value instanceof \DateTime || $value instanceof \DateTimeInterface) {

        // Otherwise use DateTime
        $comparedValue = new \DateTime($comparedValue);
      }
    }
    if (!$this
      ->compareValues($value, $comparedValue)) {
      if ($this->context instanceof ExecutionContextInterface) {
        $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))
          ->addViolation();
      }
      else {
        $this
          ->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))
          ->addViolation();
      }
    }
  }

  /**
   * Compares the two given values to find if their relationship is valid.
   *
   * @param mixed $value1 The first value to compare
   * @param mixed $value2 The second value to compare
   *
   * @return bool true if the relationship is valid, false otherwise
   */
  protected abstract function compareValues($value1, $value2);

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractComparisonValidator::compareValues	abstract protected	function	Compares the two given values to find if their relationship is valid.	8
AbstractComparisonValidator::validate	public	function	Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
ConstraintValidator::$context	protected	property		3
ConstraintValidator::buildViolation Deprecated	protected	function	Wrapper for {@link ExecutionContextInterface::buildViolation} that supports the 2.4 context API.
ConstraintValidator::buildViolationInContext Deprecated	protected	function	Wrapper for {@link ExecutionContextInterface::buildViolation} that supports the 2.4 context API.
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	1
ConstraintValidator::OBJECT_TO_STRING		constant	Whether to cast objects with a "__toString()" method to strings.
ConstraintValidator::PRETTY_DATE		constant	Whether to format {@link \DateTime} objects as RFC-3339 dates ("Y-m-d H:i:s").