ISSN
Warning: You are browsing the documentation for Symfony 3.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.2 (the current stable version).
Validates that a value is a valid International Standard Serial Number (ISSN).
| Applies to | property or method |
| Options | |
| Class | Issn |
| Validator | IssnValidator |
Basic Usage
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Journal.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Journal
{
/**
* @Assert\Issn
*/
protected $issn;
}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.
Options
groups
type: array | string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.
message
type: string default: This value is not a valid ISSN.
The message shown if the given value is not a valid ISSN.
You can use the following parameters in this message:
| Parameter | Description |
|---|---|
{{ value }} |
The current (invalid) value |
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
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.