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.

値が有効な IP アドレスであることを検証します。デフォルトでは、これは値を IPv4 として検証しますが、IPv6 および他の多くの組み合わせとして検証するためのさまざまなオプションが存在します。

Applies to	property or method
Class	Ip
Validator	IpValidator

Basic Usage ¶

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    #[Assert\Ip]
    protected $ipAddress;
}

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

    
                        <!-- 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>

    
                        // 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.

他のほとんどの制約と同様に、null および空の文字列は有効な値と見なされます。これは、それらをオプションの値にできるようにするためです。値が必須の場合、一般的な解決策は、この制約と NotBlank を組み合わせることです。

Options ¶

`groups` ¶

type: array | string

タイプ: 配列 |ストリング

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

この制約の検証グループを定義します。検証グループの詳細を参照してください。

`message` ¶

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

タイプ: 文字列デフォルト: これは有効な IP アドレスではありません。

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

このメッセージは、文字列が有効な IP アドレスでない場合に表示されます。

You can use the following parameters in this message:

このメッセージでは、次のパラメーターを使用できます。

Parameter	Description
`{{ value }}`	The current (invalid) value
`{{ label }}`	Corresponding form field label

`normalizer` ¶

type: a PHP callable default: null

タイプ: PHP 呼び出し可能デフォルト: null

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

このオプションを使用すると、有効かどうかを確認する前に、指定された値に適用される PHP 呼び出し可能オブジェクトを定義できます。

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

たとえば、検証中に先頭と末尾の空白を無視するために、trim PHP 関数を適用するために「trim」文字列を渡すことができます。

`payload` ¶

type: mixed default: null

タイプ: 混合デフォルト: 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.

このオプションは、任意のドメイン固有のデータを制約に添付するために使用できます。構成されたペイロードは Validator コンポーネントによって使用されませんが、その処理は完全にユーザー次第です。

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

タイプ: 文字列デフォルト: 4

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

これにより、IP アドレスがどのように検証されるかが正確に決定され、さまざまな値のいずれかを取ることができます。

All ranges

すべての範囲

4: Validates for IPv4 addresses
IPv4 アドレスを検証します
6: Validates for IPv6 addresses
IPv6 アドレスを検証します
all: Validates all IP formats
すべての IP フォーマットを検証

No private ranges

プライベート範囲なし

4_no_priv: Validates for IPv4 but without private IP ranges
IPv4 を検証しますが、プライベート IP 範囲は検証しません
6_no_priv: Validates for IPv6 but without private IP ranges
IPv6 を検証しますが、プライベート IP 範囲は検証しません
all_no_priv: Validates for all IP formats but without private IP ranges
すべての IP 形式を検証しますが、プライベート IP 範囲は除きます

No reserved ranges

予約範囲なし

4_no_res: Validates for IPv4 but without reserved IP ranges
IPv4 を検証しますが、予約済みの IP 範囲はありません
6_no_res: Validates for IPv6 but without reserved IP ranges
IPv6 を検証しますが、予約済みの IP 範囲はありません
all_no_res: Validates for all IP formats but without reserved IP ranges
すべての IP 形式を検証しますが、予約済みの IP 範囲はありません

Only public ranges

公開範囲のみ

4_public: Validates for IPv4 but without private and reserved ranges
IPv4 を検証しますが、プライベートおよび予約済みの範囲はありません
6_public: Validates for IPv6 but without private and reserved ranges
IPv6 を検証しますが、プライベートおよび予約済みの範囲はありません
all_public: Validates for all IP formats but without private and reserved ranges
すべての IP 形式を検証しますが、プライベートおよび予約済みの範囲は除きます

Ip ¶

Basic Usage ¶

Options ¶

groups ¶

message ¶

normalizer ¶

payload ¶

version ¶

`groups` ¶

`message` ¶

`normalizer` ¶

`payload` ¶

`version` ¶