国家

编辑此页

验证一个值是否为有效的 ISO 3166-1 alpha-2 国家代码。

适用于	属性或方法
类	国家
验证器	CountryValidator

基本用法

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/User.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Assert\Country]
    protected string $country;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\User:
    properties:
        country:
            - Country: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.ac.cn/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.ac.cn/schema/dic/constraint-mapping http://symfony.ac.cn/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\User">
        <property name="country">
            <constraint name="Country"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/User.php
namespace App\Entity;

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

class User
{
    // ...

    public static function loadValidationMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('country', new Assert\Country());
    }
}
    

注意

与其他大多数约束一样，null 和空字符串被认为是有效值。这是为了允许它们成为可选值。如果该值是强制性的，一个常见的解决方案是将此约束与 NotBlank 结合使用。

选项

alpha3

类型: boolean 默认: false

如果此选项为 true，则约束检查该值是否为 ISO 3166-1 alpha-3 三字母代码（例如，法国 = FRA），而不是默认的 ISO 3166-1 alpha-2 双字母代码（例如，法国 = FR）。

`groups`

类型: array | string 默认: null

它定义了此约束的验证组。阅读更多关于验证组的信息。

`message`

类型: string 默认: This value is not a valid country.

如果字符串不是有效的国家代码，则显示此消息。

你可以在此消息中使用以下参数

参数	描述
`{{ value }}`	当前的（无效的）国家代码

`payload`

类型: mixed 默认: null

此选项可用于将任意特定于域的数据附加到约束。配置的 payload 不会被验证器组件使用，但其处理完全取决于你。

例如，你可能想要使用几个错误级别，以便根据错误严重程度在前端以不同方式呈现失败的约束。

本作品，包括代码示例，根据 Creative Commons BY-SA 3.0 许可获得许可。

版本