Isbn

Warning: You are browsing the documentation for Symfony 6.2, which is no longer maintained.

Read the updated version of this page for Symfony 7.1 (the current stable version).

Isbn

This constraint validates that an International Standard Book Number (ISBN) is either a valid ISBN-10 or a valid ISBN-13.

Applies to	property or method
Class	Isbn
Validator	IsbnValidator

Basic Usage

To use the Isbn validator, apply it to a property or method on an object that will contain an 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.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\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.',
        ]));
    }
}
    

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.

Available Options

`bothIsbnMessage`

type: string default: This value is neither a valid ISBN-10 nor a valid ISBN-13.

The message that will be shown if the type option is null and the given value does not pass any of the ISBN checks.

You can use the following parameters in this message:

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

`groups`

type: array | string default: null

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

`isbn10Message`

type: string default: This value is not a valid ISBN-10.

The message that will be shown if the type option is isbn10 and the given value does not pass the ISBN-10 check.

You can use the following parameters in this message:

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

`isbn13Message`

type: string default: This value is not a valid ISBN-13.

The message that will be shown if the type option is isbn13 and the given value does not pass the ISBN-13 check.

You can use the following parameters in this message:

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

`message`

type: string default: null

The message that will be shown if the value is not valid. If not null, this message has priority over all the other messages.

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

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.

`type`

type: string default: null

The type of ISBN to validate against. Valid values are isbn10, isbn13 and null to accept any kind of ISBN.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version