You are here

Home » API reference » Plug 7 » IpValidator.php

class IpValidator in Plug 7

Validates whether a value is a valid IP address.

@author Bernhard Schussek <bschussek@gmail.com> @author Joseph Bielawski <stloyd@gmail.com>

@api

Hierarchy

Expanded class hierarchy of IpValidator

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

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/IpValidator.php, line 26

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof Ip) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Ip');
    }
    if (null === $value || '' === $value) {
      return;
    }
    if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {
      throw new UnexpectedTypeException($value, 'string');
    }
    $value = (string) $value;
    switch ($constraint->version) {
      case Ip::V4:
        $flag = FILTER_FLAG_IPV4;
        break;
      case Ip::V6:
        $flag = FILTER_FLAG_IPV6;
        break;
      case Ip::V4_NO_PRIV:
        $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE;
        break;
      case Ip::V6_NO_PRIV:
        $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE;
        break;
      case Ip::ALL_NO_PRIV:
        $flag = FILTER_FLAG_NO_PRIV_RANGE;
        break;
      case Ip::V4_NO_RES:
        $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_RES_RANGE;
        break;
      case Ip::V6_NO_RES:
        $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_RES_RANGE;
        break;
      case Ip::ALL_NO_RES:
        $flag = FILTER_FLAG_NO_RES_RANGE;
        break;
      case Ip::V4_ONLY_PUBLIC:
        $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
        break;
      case Ip::V6_ONLY_PUBLIC:
        $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
        break;
      case Ip::ALL_ONLY_PUBLIC:
        $flag = FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
        break;
      default:
        $flag = null;
        break;
    }
    if (!filter_var($value, FILTER_VALIDATE_IP, $flag)) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->addViolation();
    }
  }

}

Members

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