diff --git a/reference/constraints/Issn.rst b/reference/constraints/Issn.rst new file mode 100644 index 00000000000..89dcbb6bcb7 --- /dev/null +++ b/reference/constraints/Issn.rst @@ -0,0 +1,101 @@ +Issn +==== + +.. versionadded:: 2.3 + The ISSN validation is new in Symfony 2.3. + +Validates that a value is a valid `ISSN`_. + ++----------------+-----------------------------------------------------------------------+ +| Applies to | :ref:`property or method` | ++----------------+-----------------------------------------------------------------------+ +| Options | - `message`_ | +| | - `caseSensitive`_ | +| | - `requireHyphen`_ | ++----------------+-----------------------------------------------------------------------+ +| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Issn` | ++----------------+-----------------------------------------------------------------------+ +| Validator | :class:`Symfony\\Component\\Validator\\Constraints\\IssnValidator` | ++----------------+-----------------------------------------------------------------------+ + +Basic Usage +----------- + +.. configuration-block:: + + .. code-block:: yaml + + # src/JournalBundle/Resources/config/validation.yml + Acme\JournalBundle\Entity\Journal: + properties: + issn: + - Issn: ~ + + .. code-block:: php-annotations + + // src/Acme/JournalBundle/Entity/Journal.php + namespace Acme\JournalBundle\Entity; + + use Symfony\Component\Validator\Constraints as Assert; + + class Journal + { + /** + * @Assert\Issn + */ + protected $issn; + } + + .. code-block:: xml + + + + + + + + + .. code-block:: php + + // 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 an hyphenathed ISSN value. + +.. _`ISSN`: http://en.wikipedia.org/wiki/Issn + diff --git a/reference/constraints/map.rst.inc b/reference/constraints/map.rst.inc index 3d10d637ccf..338ab62dec7 100644 --- a/reference/constraints/map.rst.inc +++ b/reference/constraints/map.rst.inc @@ -63,3 +63,4 @@ Other Constraints * :doc:`All ` * :doc:`UserPassword ` * :doc:`Valid ` +* :doc:`Issn `