IP
Edit this pageWarning: You are browsing the documentation for Symfony 3.4, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
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 | Ip |
| Validator | IpValidator |
Basic Usage
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Ip
*/
protected $ipAddress;
}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
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
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:
| Parameter | Description |
|---|---|
{{ value }} |
The current (invalid) value |
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.
