Isbn
Edit this pageWarning: You are browsing the documentation for Symfony 2.8, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
Isbn
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 | |
| Class | Isbn |
| Validator | IsbnValidator |
Basic Usage
To use the Isbn validator, simply 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 14 15
// 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;
}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.
