Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Issn
WARNING:

You are browsing the documentation for Symfony 2.6 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

Issn

2.6 version
Maintained
4.4 5.2 current 5.3 dev
Unmaintained
2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

Issn

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

Validates that a value is a valid International Standard Serial Number (ISSN).

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Issn
Validator Symfony\Component\Validator\Constraints\IssnValidator

Basic Usage

  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Acme/JournalBundle/Entity/Journal.php
namespace Acme\JournalBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Journal
{
    /**
     * @Assert\Issn
     */
     protected $issn;
}
  • YAML
    1
2
3
4
5
    # src/Acme/JournalBundle/Resources/config/validation.yml
Acme\JournalBundle\Entity\Journal:
    properties:
        issn:
            - Issn: ~
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- src/Acme/JournalBundle/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="Acme\JournalBundle\Entity\Journal">
        <property name="issn">
            <constraint name="Issn" />
        </property>
    </class>
</constraint-mapping>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Acme/JournalBundle/Entity/Journal.php
namespace Acme\JournalBundle\Entity;

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

class Journal
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('issn', new Assert\Issn());
    }
}

Options

message

type: String default: This value is not a valid ISSN.

The message shown if the given value is not a valid ISSN.

caseSensitive

type: boolean default: false

The validator will allow ISSN values to end with a lower case ‘x’ by default. When switching this to true, the validator requires an upper case ‘X’.

requireHyphen

type: boolean default: false

The validator will allow non hyphenated ISSN values by default. When switching this to true, the validator requires a hyphenated ISSN value.

payload

type: mixed default: null

New in version 2.6: The payload option was introduced in Symfony 2.6.

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.