Merge pull request symfony#2864 from WouterJ/issue_2833

weaverryan · weaverryan · commit bd0dc8bb2456 · 2013-08-17T09:55:44.000-07:00
Documented htmlPattern option
diff --git a/reference/constraints/Regex.rst b/reference/constraints/Regex.rst
@@ -7,6 +7,7 @@ Validates that a value matches a regular expression.
 | Applies to     | :ref:`property or method<validation-property-target>`                 |
 +----------------+-----------------------------------------------------------------------+
 | Options        | - `pattern`_                                                          |
+|                | - `htmlPattern`_                                                      |
 |                | - `match`_                                                            |
 |                | - `message`_                                                          |
 +----------------+-----------------------------------------------------------------------+
@@ -161,6 +162,87 @@ does *not* match this regular expression (via the :phpfunction:`preg_match` PHP
 However, if `match`_ is set to false, then validation will fail if the input
 string *does* match this pattern.
 
+htmlPattern
+~~~~~~~~~~~
+
+.. versionadded:: 2.1
+    The ``htmlPattern`` option was added in Symfony 2.1
+
+**type**: ``string|Boolean`` **default**: null
+
+This option specifies the pattern to use in the html5 ``pattern`` attribute.
+By default, the constraint will convert the pattern given in the ``pattern``
+option into a html5 compatible pattern. This means that the delimeters are
+removed (e.g. ``/[a-z]+/`` becomes ``[a-z]+``).
+
+However, their are some other incompatibilities between both patterns which
+cannot be fixed by the constraint. For instance, the html5 pattern attribute
+does not support flags. If you have a pattern like ``/[a-z]+/i`` you need to
+specify the html5 compatible pattern in the ``htmlPattern`` option:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # src/Acme/BlogBundle/Resources/config/validation.yml
+        Acme\BlogBundle\Entity\Author:
+            properties:
+                name:
+                    - Regex:
+                        pattern: "/^[a-z]+$/i"
+                        htmlPattern: "^[a-zA-Z]+$"
+
+    .. code-block:: php-annotations
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        namespace Acme\BlogBundle\Entity;
+        
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            /**
+             * @Assert\Regex({
+             *     pattern     = "/^[a-z]+$/i",
+             *     htmlPattern = "^[a-zA-Z]+$"
+             * })
+             */
+            protected $name;
+        }
+
+    .. code-block:: xml
+
+        <!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
+        <class name="Acme\BlogBundle\Entity\Author">
+            <property name="name">
+                <constraint name="Regex">
+                    <option name="pattern">/^[a-z]+$/i</option>
+                    <option name="htmlPattern">^[a-zA-Z]+$</option>
+                </constraint>
+            </property>
+        </class>
+
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        namespace Acme\BlogBundle\Entity;
+        
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('name', new Assert\Regex(array(
+                    'pattern'     => '/^[a-z]+$/i',
+                    'htmlPattern' => '^[a-zA-Z]+$',
+                )));
+            }
+        }
+
+Setting ``htmlPattern`` to false will disable client side validation.
+
 match
 ~~~~~
 
