Hostname

This constraint ensures that the given value is a valid host name (internally it uses the FILTER_VALIDATE_DOMAIN option of the filter_var PHP function).

この制約は、指定された値が有効なホスト名であることを保証します (内部的には、filter_var PHP 関数の FILTER_VALIDATE_DOMAIN オプションを使用します)。
Applies to property or method
Class Hostname
Validator HostnameValidator

Basic Usage

To use the Hostname validator, apply it to a property on an object that will contain a host name.

ホスト名バリデータを使用するには、ホスト名を含むオブジェクトのプロパティに適用します。
  • Attributes
    属性
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
 
// src/Entity/ServerSettings.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class ServerSettings
{
    #[Assert\Hostname(message: 'The server name must be a valid hostname.')]
    protected $name;
}

The following top-level domains (TLD) are reserved according to RFC 2606 and that's why hostnames containing them are not considered valid: .example, .invalid, .localhost, and .test.

次のトップレベル ドメイン (TLD) は RFC 2606 に従って予約されているため、それらを含むホスト名は有効と見なされません: .example、.invalid、.localhost、および .test。

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 value is not a valid hostname.

タイプ: 文字列 デフォルト: この値は有効なホスト名ではありません。

The default message supplied when the value is not a valid hostname.

値が有効なホスト名でない場合に提供されるデフォルトのメッセージ。

You can use the following parameters in this message:

このメッセージでは、次のパラメーターを使用できます。
Parameter Description
{{ value }} The current (invalid) value
{{ label }} Corresponding form field label

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.

たとえば、いくつかのエラー レベルを使用して、エラーの重大度に応じて、失敗した制約をフロントエンドで異なる方法で提示することができます。

requireTld

type: boolean default: true

タイプ: ブール デフォルト: true

By default, hostnames are considered valid only when they are fully qualified and include their TLDs (top-level domain names). For instance, example.com is valid but example is not.

デフォルトでは、ホスト名は完全修飾されており、TLD (トップレベル ドメイン名) が含まれている場合にのみ有効と見なされます。たとえば、example.com は有効ですが、example は有効ではありません。

Set this option to false to not require any TLD in the hostnames.

ホスト名に TLD を必要としない場合は、このオプションを false に設定します。

Note

ノート

This constraint does not validate that the given TLD value is included in the list of official top-level domains (because that list is growing continuously and it's hard to keep track of it).

この制約は、指定された TLD 値が公式のトップレベル ドメインのリストに含まれていることを検証しません (そのリストは増え続けており、追跡するのが難しいため)。