Ip

Ip

Validates that a value is a valid IP address. By default, this will validate the value as IPv4, but a number of different options exist to validate as IPv6 and many other combinations.

Basic Usage

• Annotations

  // src/Entity/Author.php
  namespace App\Entity;
  use Symfony\Component\Validator\Constraints as Assert;
  class Author
  {
      /**
       * @Assert\Ip
       */
      protected $ipAddress;
  }

• YAML

  # config/validator/validation.yaml
  App\Entity\Author:
      properties:
          ipAddress:
              - Ip: ~

• XML

  <!-- config/validator/validation.xml -->
  <?xml version="1.0" encoding="UTF-8" ?>
  <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
      <class name="App\Entity\Author">
          <property name="ipAddress">
              <constraint name="Ip"/>
          </property>
      </class>
  </constraint-mapping>

• PHP

  // src/Entity/Author.php
  namespace App\Entity;
  use Symfony\Component\Validator\Constraints as Assert;
  use Symfony\Component\Validator\Mapping\ClassMetadata;
  class Author
  {
      public static function loadValidatorMetadata(ClassMetadata $metadata)
      {
          $metadata->addPropertyConstraint('ipAddress', new Assert\Ip());
      }
  }

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

type: string default: This is not a valid IP address.

This message is shown if the string is not a valid IP address.

You can use the following parameters in this message:

normalizer

type: a PHP callable default: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

For example, you may want to pass the 'trim' string to apply the [trim](https://www.php.net/manual/en/function.trim.php "trim") PHP function in order to ignore leading and trailing whitespace during validation.

payload

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

version

type: string default: 4

This determines exactly how the IP address is validated and can take one of a variety of different values:

All ranges

4

Validates for IPv4 addresses

6

Validates for IPv6 addresses

all

Validates all IP formats

No private ranges

4_no_priv

Validates for IPv4 but without private IP ranges

6_no_priv

Validates for IPv6 but without private IP ranges

all_no_priv

Validates for all IP formats but without private IP ranges

No reserved ranges

4_no_res

Validates for IPv4 but without reserved IP ranges

6_no_res

Validates for IPv6 but without reserved IP ranges

all_no_res

Validates for all IP formats but without reserved IP ranges

Only public ranges

4_public

Validates for IPv4 but without private and reserved ranges

6_public

Validates for IPv6 but without private and reserved ranges

all_public

Validates for all IP formats but without private and reserved ranges

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.