1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Ip
WARNING: You are browsing the documentation for Symfony 2.6 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

Ip

2.6 version
Maintained
3.4 4.4 5.1 current 5.2 master
Unmaintained
2.0 2.1 2.2 2.3 2.4 2.5 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

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.

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Ip
Validator Symfony\Component\Validator\Constraints\IpValidator

Basic Usage

  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Ip
     */
     protected $ipAddress;
}
  • YAML
    1
2
3
4
5
    # src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
    properties:
        ipAddress:
            - Ip: ~
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- src/Acme/BlogBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="Acme\BlogBundle\Entity\Author">
        <property name="ipAddress">
            <constraint name="Ip" />
        </property>
    </class>
</constraint-mapping>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('ipAddress', new Assert\Ip());
    }
}

Options

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

message

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

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

payload

type: mixed default: null

New in version 2.6: The payload option was introduced in Symfony 2.6.

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.

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