8000 Updated ISBN validator docs by sprain · Pull Request #3724 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Updated ISBN validator docs #3724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Updated ISBN validator docs #3724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 33 additions & 30 deletions reference/constraints/Isbn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@ Isbn
.. versionadded:: 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, a valid ISBN-13 or both.
is either a valid ISBN-10 or a valid ISBN-13.

+----------------+----------------------------------------------------------------------+
| Applies to | :ref:`property or method<validation-property-target>` |
+----------------+----------------------------------------------------------------------+
| Options | - `isbn10`_ |
| | - `isbn13`_ |
| Options | - `type`_ |
| | - `message`_ |
| | - `isbn10Message`_ |
| | - `isbn13Message`_ |
| | - `bothIsbnMessage`_ |
Expand All @@ -25,7 +32,7 @@ Basic Usage
-----------

To use the ``Isbn`` validator, simply apply it to a property or method
on an object that will contain a ISBN number.
on an object that will contain an ISBN.

.. configuration-block::

Expand All @@ -36,9 +43,8 @@ on an object that will contain a ISBN number.
properties:
isbn:
- Isbn:
isbn10: true
isbn13: true
bothIsbnMessage: This value is neither a valid ISBN-10 nor a valid ISBN-13.
type: isbn10
message: This value is not valid.

.. code-block:: php-annotations

Expand All @@ -49,9 +55,8 @@ on an object that will contain a ISBN number.
{
/**
* @Assert\Isbn(
* isbn10 = true,
* isbn13 = true,
* bothIsbnMessage = "This value is neither a valid ISBN-10 nor a valid ISBN-13."
* type = isbn10,
* message: This value is not valid.
* )
*/
protected $isbn;
Expand All @@ -63,9 +68,8 @@ on an object that will contain a ISBN number.
<class name="Acme\BookcaseBundle\Entity\Book">
<property name="isbn">
<constraint name="Isbn">
<option name="isbn10">true</option>
<option name="isbn13">true</option>
<option name="bothIsbnMessage">This value is neither a valid ISBN-10 nor a valid ISBN-13.</option>
<option name="type">isbn10</option>
<option name="message">This value is not valid.</option>
</constraint>
</property>
</class>
Expand All @@ -85,54 +89,53 @@ on an object that will contain a ISBN number.
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('isbn', new Assert\Isbn(array(
'isbn10' => true,
'isbn13' => true,
'bothIsbnMessage' => 'This value is neither a valid ISBN-10 nor a valid ISBN-13.'
'type' => isbn10,
'message' => 'This value is not valid.'
)));
}
}

Available Options
-----------------

isbn10
~~~~~~
type
~~~~

**type**: ``boolean``
**type**: ``string`` **default**: ``null``

If this required option is set to ``true`` the constraint will check if the
code is a valid ISBN-10 code.
The type of ISBN to validate against.
Valid values are ``isbn10``, ``isbn13`` and ``null`` to accept any kind of ISBN.

isbn13
~~~~~~
message
~~~~~~~

**type**: ``boolean``
**type**: ``string`` **default**: ``null``

If this required option is set to ``true`` the constraint will check if the
code is a valid ISBN-13 code.
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 `isbn10`_ option is true and the given
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 `isbn13`_ option is true and the given
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 both the `isbn10`_ and `isbn13`_ options
are true and the given value does not pass the ISBN-13 nor the ISBN-13 check.
The message that will be shown if the `type`_ option is ``null`` and the given
value does not pass any of the ISBN checks.

.. _`International Standard Book Number (ISBN)`: http://en.wikipedia.org/wiki/Isbn
0