Isbn

编辑此页

此约束验证国际标准书号 (ISBN)是有效的 ISBN-10 或有效的 ISBN-13。

适用于	属性或方法
类	Isbn
验证器	IsbnValidator

基本用法

要使用 Isbn 验证器，请将其应用于将包含 ISBN 的对象的属性或方法。

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

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    #[Assert\Isbn(
        type: Assert\Isbn::ISBN_10,
        message: 'This value is not valid.',
    )]
    protected string $isbn;
}
    

        1
2
3
4
5
6
7
        # config/validator/validation.yaml
App\Entity\Book:
    properties:
        isbn:
            - Isbn:
                type: isbn10
                message: This value is not valid.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- 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\Book">
        <property name="isbn">
            <constraint name="Isbn">
                <option name="type">isbn10</option>
                <option name="message">This value is not valid.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

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

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

class Book
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('isbn', new Assert\Isbn([
            'type' => Assert\Isbn::ISBN_10,
            'message' => 'This value is not valid.',
        ]));
    }
}
    

注意

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

可用选项

`bothIsbnMessage`

type: string default: 该值既不是有效的 ISBN-10，也不是有效的 ISBN-13。

如果 type 选项为 null 且给定值未通过任何 ISBN 检查，则将显示的消息。

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

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`groups`

type: array | string default: null

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

`isbn10Message`

type: string default: 该值不是有效的 ISBN-10。

如果 type 选项为 isbn10 且给定值未通过 ISBN-10 检查，则将显示的消息。

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

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`isbn13Message`

type: string default: 该值不是有效的 ISBN-13。

如果 type 选项为 isbn13 且给定值未通过 ISBN-13 检查，则将显示的消息。

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

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`message`

type: string default: null

如果值无效，则将显示的消息。如果不是 null，则此消息优先于所有其他消息。

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

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`payload`

type: mixed default: null

此选项可用于将任意特定于域的数据附加到约束。配置的有效负载不由 Validator 组件使用，但其处理完全取决于您。

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

`type`

type: string default: null

要验证的 ISBN 类型。有效值为 isbn10、isbn13 和 null 以接受任何类型的 ISBN。

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

版本