You are here

class Ip in Plug 7

Validates that a value is a valid IP address.

@Target({"PROPERTY", "METHOD", "ANNOTATION"})

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

@api

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Ip

Expanded class hierarchy of Ip

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

File

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

Namespace

Symfony\Component\Validator\Constraints
View source
class Ip extends Constraint {
  const V4 = '4';
  const V6 = '6';
  const ALL = 'all';

  // adds FILTER_FLAG_NO_PRIV_RANGE flag (skip private ranges)
  const V4_NO_PRIV = '4_no_priv';
  const V6_NO_PRIV = '6_no_priv';
  const ALL_NO_PRIV = 'all_no_priv';

  // adds FILTER_FLAG_NO_RES_RANGE flag (skip reserved ranges)
  const V4_NO_RES = '4_no_res';
  const V6_NO_RES = '6_no_res';
  const ALL_NO_RES = 'all_no_res';

  // adds FILTER_FLAG_NO_PRIV_RANGE and FILTER_FLAG_NO_RES_RANGE flags (skip both)
  const V4_ONLY_PUBLIC = '4_public';
  const V6_ONLY_PUBLIC = '6_public';
  const ALL_ONLY_PUBLIC = 'all_public';
  protected static $versions = array(
    self::V4,
    self::V6,
    self::ALL,
    self::V4_NO_PRIV,
    self::V6_NO_PRIV,
    self::ALL_NO_PRIV,
    self::V4_NO_RES,
    self::V6_NO_RES,
    self::ALL_NO_RES,
    self::V4_ONLY_PUBLIC,
    self::V6_ONLY_PUBLIC,
    self::ALL_ONLY_PUBLIC,
  );
  public $version = self::V4;
  public $message = 'This is not a valid IP address.';

  /**
   * {@inheritdoc}
   */
  public function __construct($options = null) {
    parent::__construct($options);
    if (!in_array($this->version, self::$versions)) {
      throw new ConstraintDefinitionException(sprintf('The option "version" must be one of "%s"', implode('", "', self::$versions)));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Constraint::$errorNames protected static property Maps error codes to the names of their constants 16
Constraint::$payload public property Domain-specific data attached to a constraint
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 1
Constraint::CLASS_CONSTRAINT constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP constant The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption public function Returns the name of the default option. 15
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getRequiredOptions public function Returns the name of the required options. 7
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or both. 11
Constraint::PROPERTY_CONSTRAINT constant Marks a constraint that can be put onto properties.
Constraint::validatedBy public function Returns the name of the class that validates this constraint. 1
Constraint::__get public function Returns the value of a lazily initialized option.
Constraint::__set public function Sets the value of a lazily initialized option.
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
Ip::$message public property
Ip::$version public property
Ip::$versions protected static property
Ip::ALL constant
Ip::ALL_NO_PRIV constant
Ip::ALL_NO_RES constant
Ip::ALL_ONLY_PUBLIC constant
Ip::V4 constant
Ip::V4_NO_PRIV constant
Ip::V4_NO_RES constant
Ip::V4_ONLY_PUBLIC constant
Ip::V6 constant
Ip::V6_NO_PRIV constant
Ip::V6_NO_RES constant
Ip::V6_ONLY_PUBLIC constant
Ip::__construct public function Initializes the constraint with options. Overrides Constraint::__construct