Symfony
sponsored by SensioLabs
Menu
  • About
  • Documentation
  • Screencasts
  • Cloud
  • Certification
  • Community
  • Businesses
  • News
  • Download
  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Isbn
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud
Search by Algolia

Table of Contents

  • Basic Usage
  • Available Options
    • type
    • message
    • isbn10Message
    • isbn13Message
    • bothIsbnMessage
    • payload

Isbn

Edit this page

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

Read the updated version of this page for Symfony 6.2 (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
  • type
  • message
  • isbn10Message
  • isbn13Message
  • bothIsbnMessage
  • payload
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.

  • Annotations
  • YAML
  • XML
  • PHP
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;
}
1
2
3
4
5
6
7
# src/AppBundle/Resources/config/validation.yml
AppBundle\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
<!-- 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>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 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.
We stand with Ukraine.
Version:
Symfony Code Performance Profiling

Symfony Code Performance Profiling

Code consumes server resources. Blackfire tells you how

Code consumes server resources. Blackfire tells you how

↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

Avatar of André Matthies, a Symfony contributor

Thanks André Matthies for being a Symfony contributor

1 commit • 5 lines changed

View all contributors that help us make Symfony

Become a Symfony contributor

Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

Learn how to contribute

Symfony™ is a trademark of Symfony SAS. All rights reserved.

  • What is Symfony?
    • Symfony at a Glance
    • Symfony Components
    • Case Studies
    • Symfony Releases
    • Security Policy
    • Logo & Screenshots
    • Trademark & Licenses
    • symfony1 Legacy
  • Learn Symfony
    • Symfony Docs
    • Symfony Book
    • Reference
    • Bundles
    • Best Practices
    • Training
    • eLearning Platform
    • Certification
  • Screencasts
    • Learn Symfony
    • Learn PHP
    • Learn JavaScript
    • Learn Drupal
    • Learn RESTful APIs
  • Community
    • SymfonyConnect
    • Support
    • How to be Involved
    • Code of Conduct
    • Events & Meetups
    • Projects using Symfony
    • Downloads Stats
    • Contributors
    • Backers
  • Blog
    • Events & Meetups
    • A week of symfony
    • Case studies
    • Cloud
    • Community
    • Conferences
    • Diversity
    • Documentation
    • Living on the edge
    • Releases
    • Security Advisories
    • SymfonyInsight
    • Twig
    • SensioLabs
  • Services
    • SensioLabs services
    • Train developers
    • Manage your project quality
    • Improve your project performance
    • Host Symfony projects
    Deployed on
Follow Symfony
Search by Algolia