Isbn

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
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.

  • Annotations
     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;
    }
    
  • YAML
    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.
    
  • XML
     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>
    
  • PHP
     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.'
            )));
        }
    }
    

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.

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.

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.

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.

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.