Skip to content

Commit ea3d231

Browse files
committed
document the 2.5 validation options
1 parent 87365fa commit ea3d231

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

reference/configuration/framework.rst

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ Configuration
4848
* `translator`_
4949
* :ref:`enabled <translator.enabled>`
5050
* `fallback`_
51+
* `validation`_
52+
* `cache`_
53+
* `enable_annotations`_
54+
* `translation_domain`_
55+
* `strict_email`_
56+
* `api`_
5157

5258
secret
5359
~~~~~~
@@ -517,6 +523,70 @@ This option is used when the translation key for the current locale wasn't found
517523

518524
For more details, see :doc:`/book/translation`.
519525

526+
validation
527+
~~~~~~~~~~
528+
529+
cache
530+
.....
531+
532+
**type**: ``string``
533+
534+
This value is used to determine the service that is used to persist class
535+
metadata in a cache. The actual service name is built by prefixing the configured
536+
value with ``validator.mapping.cache.`` (e.g. if the value is ``apc``, the
537+
``validator.mapping.cache.apc`` service will be injected). The service has
538+
to implement the :class:`Symfony\\Component\\Validator\\Mapping\\Cache\\CacheInterface`.
539+
540+
enable_annotations
541+
..................
542+
543+
**type**: ``Boolean`` **default**: ``false``
544+
545+
If this option is enabled, validation constraints can be defined using annotations.
546+
547+
translation_domain
548+
..................
549+
550+
**type**: ``string`` **default**: ``validators``
551+
552+
The translation domain that is used when translating validation constraint
553+
error messages.
554+
555+
strict_email
556+
............
557+
558+
.. versionadded:: 2.5
559+
The ``strict_email`` option was introduced in Symfony 2.5.
560+
561+
**type**: ``Boolean`` **default**: ``false``
562+
563+
If this option is enabled, the `egulias/email-validator`_ library will be
564+
used by the :doc:`/reference/constraints/Email` constraint validator. Otherwise,
565+
the validator uses a simple regular expression to validate email addresses.
566+
567+
api
568+
...
569+
570+
.. versionadded:: 2.5
571+
The ``api`` option was introduced in Symfony 2.5.
572+
573+
**type**: ``string``
574+
575+
Starting with Symfony 2.5, the Validator component introduced a new validation
576+
API. The ``api`` option is used to switch between the different implementations:
577+
578+
``2.4``
579+
Use the vaidation API that is compatible with older Symfony versions.
580+
581+
``2.5``
582+
Use the validation API introduced in Symfony 2.5.
583+
584+
``2.5-bc`` or ``auto``
585+
If you omit a value or set the ``api`` option to ``2.5-bc`` or ``auto``,
586+
Symfony will use an API implementation that is compatible with both the
587+
legacy implementation and the ``2.5`` implementation. You have to use
588+
PHP 5.3.9 or higher to be able to use this implementation.
589+
520590
Full default Configuration
521591
--------------------------
522592

@@ -646,3 +716,4 @@ Full default Configuration
646716
647717
.. _`protocol-relative`: http://tools.ietf.org/html/rfc3986#section-4.2
648718
.. _`PhpStormOpener`: https://github.com/pinepain/PhpStormOpener
719+
.. _`egulias/email-validator`: https://github.com/egulias/EmailValidator

0 commit comments

Comments
 (0)