WARNING: You are browsing the documentation for Symfony 2.8 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

Isbn

2.8 version

Maintained

3.4 4.4 5.1 current 5.2 master

Unmaintained

2.3 2.4 2.5 2.6 2.7 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

Isbn
- Basic Usage
- Available Options

Isbn¶

New in version 2.3: The Isbn constraint was introduced in Symfony 2.3.

Caution

The isbn10 and isbn13 options are deprecated since Symfony 2.5 and will be removed in Symfony 3.0. Use the type option instead. Furthermore, when using the type option, lowercase characters are no longer supported starting in Symfony 2.5, as they are not allowed in ISBNs.

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
Options	type message isbn10Message isbn13Message bothIsbnMessage payload
Class	`Symfony\Component\Validator\Constraints\Isbn`
Validator	`Symfony\Component\Validator\Constraints\IsbnValidator`

Basic Usage¶

To use the Isbn validator, simply apply it to a property or method on an object that will contain an ISBN.

Annotations

// src/AppBundle/Entity/Book.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    /**
     * @Assert\Isbn(
     *     type = "isbn10",
     *     message = "This value is not  valid."
     * )
     */
    protected $isbn;
}

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Book:
    properties:
        isbn:
            - Isbn:
                type: isbn10
                message: This value is not  valid.

XML

<!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="AppBundle\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>

PHP

// src/AppBundle/Entity/Book.php
namespace AppBundle\Entity;

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

class Book
{
    protected $isbn;

    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('isbn', new Assert\Isbn(array(
            'type'    => 'isbn10',
            '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¶

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.

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

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

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

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

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.

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