You are here

class ChoiceValidator in Plug 7

ChoiceValidator validates that the value is one of the expected values.

@author Fabien Potencier <fabien@symfony.com> @author Florian Eckerstorfer <florian@eckerstorfer.org> @author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

Expanded class hierarchy of ChoiceValidator

1 file declares its use of ChoiceValidator
ChoiceValidatorTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/ChoiceValidatorTest.php

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/ChoiceValidator.php, line 28

Namespace

Symfony\Component\Validator\Constraints
View source
class ChoiceValidator extends ConstraintValidator {

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof Choice) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Choice');
    }
    if (!is_array($constraint->choices) && !$constraint->callback) {
      throw new ConstraintDefinitionException('Either "choices" or "callback" must be specified on constraint Choice');
    }
    if (null === $value) {
      return;
    }
    if ($constraint->multiple && !is_array($value)) {
      throw new UnexpectedTypeException($value, 'array');
    }
    if ($constraint->callback) {
      if (!is_callable($choices = array(
        $this->context
          ->getClassName(),
        $constraint->callback,
      )) && !is_callable($choices = $constraint->callback)) {
        throw new ConstraintDefinitionException('The Choice constraint expects a valid callback');
      }
      $choices = call_user_func($choices);
    }
    else {
      $choices = $constraint->choices;
    }
    if ($constraint->multiple) {
      foreach ($value as $_value) {
        if (!in_array($_value, $choices, $constraint->strict)) {
          $this
            ->buildViolation($constraint->multipleMessage)
            ->setParameter('{{ value }}', $this
            ->formatValue($_value))
            ->setCode(Choice::NO_SUCH_CHOICE_ERROR)
            ->setInvalidValue($_value)
            ->addViolation();
          return;
        }
      }
      $count = count($value);
      if ($constraint->min !== null && $count < $constraint->min) {
        $this
          ->buildViolation($constraint->minMessage)
          ->setParameter('{{ limit }}', $constraint->min)
          ->setPlural((int) $constraint->min)
          ->setCode(Choice::TOO_FEW_ERROR)
          ->addViolation();
        return;
      }
      if ($constraint->max !== null && $count > $constraint->max) {
        $this
          ->buildViolation($constraint->maxMessage)
          ->setParameter('{{ limit }}', $constraint->max)
          ->setPlural((int) $constraint->max)
          ->setCode(Choice::TOO_MANY_ERROR)
          ->addViolation();
        return;
      }
    }
    elseif (!in_array($value, $choices, $constraint->strict)) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->setCode(Choice::NO_SUCH_CHOICE_ERROR)
        ->addViolation();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ChoiceValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
ConstraintValidator::$context protected property
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").