Added PHP config format

wouterj · wouterj · commit 72a6d5926685 · 2012-12-31T17:17:41.000+01:00
diff --git a/reference/constraints/All.rst b/reference/constraints/All.rst
@@ -58,14 +58,33 @@ entry in that array:
                 <constraint name="All">
                     <option name="constraints">
                         <constraint name="NotBlank" />
-                        <constraint name="Length">
-                            <option name="min">5</option>
+                        <constraint name="MinLength">
+                            <option name="limit">5</option>
                         </constraint>
                     </option>
                 </constraint>
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/UserBundle/Enttiy/User.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class User
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('favoriteColors', new Assert\All(array(
+                    'constraints' => array(
+                        new Assert\NotBlank(),
+                        new Assert\MinLength(array('limit' => 5)),
+                    ),
+                )));
+            }
+        }
+
 Now, each entry in the ``favoriteColors`` array will be validated to not
 be blank and to be at least 5 characters long.
 
diff --git a/reference/constraints/Blank.rst b/reference/constraints/Blank.rst
@@ -52,6 +52,20 @@ of an ``Author`` class were blank, you could do the following:
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('firstName', new Assetc\Blank());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Callback.rst b/reference/constraints/Callback.rst
@@ -63,6 +63,22 @@ Setup
             </constraint>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addConstraint(new Assert\Callback(array(
+                    'methods' => array('isAuthorValid'),
+                )));
+            }
+        }
+
 The Callback Method
 -------------------
 
diff --git a/reference/constraints/Choice.rst b/reference/constraints/Choice.rst
@@ -78,15 +78,15 @@ If your valid choice list is simple, you can pass them in directly via the
 
         // src/Acme/BlogBundle/EntityAuthor.php
         use Symfony\Component\Validator\Mapping\ClassMetadata;
-        use Symfony\Component\Validator\Constraints\Choice;
+        use Symfony\Component\Validator\Constraints as Assert;
         
         class Author
         {
             protected $gender;
             
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
-                $metadata->addPropertyConstraint('gender', new Choice(array(
+                $metadata->addPropertyConstraint('gender', new Assert\Choice(array(
                     'choices' => array('male', 'female'),
                     'message' => 'Choose a valid gender',
                 )));
diff --git a/reference/constraints/Collection.rst b/reference/constraints/Collection.rst
@@ -120,20 +120,18 @@ blank but is no longer than 100 characters in length, you would do the following
 
         // src/Acme/BlogBundle/Entity/Author.php
         use Symfony\Component\Validator\Mapping\ClassMetadata;
-        use Symfony\Component\Validator\Constraints\Collection;
-        use Symfony\Component\Validator\Constraints\Email;
-        use Symfony\Component\Validator\Constraints\MaxLength;
+        use Symfony\Component\Validator\Constraints as Assert;
 
         class Author
         {
             private $options = array();
 
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
-                $metadata->addPropertyConstraint('profileData', new Collection(array(
+                $metadata->addPropertyConstraint('profileData', new Assert\Collection(array(
                     'fields' => array(
-                        'personal_email' => new Email(),
-                        'lastName' => array(new NotBlank(), new MaxLength(100)),
+                        'personal_email' => new Assert\Email(),
+                        'lastName' => array(new Assert\NotBlank(), new Assert\MaxLength(100)),
                     ),
                     'allowMissingFields' => true,
                 )));
diff --git a/reference/constraints/Country.rst b/reference/constraints/Country.rst
@@ -50,6 +50,20 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/UserBundle/Entity/User.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class User
+        {
+            public static function loadValidationMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('country', new Assert\Country());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Date.rst b/reference/constraints/Date.rst
@@ -50,6 +50,20 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('birthday', new Assert\Date());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/DateTime.rst b/reference/constraints/DateTime.rst
@@ -52,6 +52,20 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('createdAt', new Assert\DataTime());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Email.rst b/reference/constraints/Email.rst
@@ -65,6 +65,25 @@ Basic Usage
              protected $email;
         }
 
+    .. 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('email', new Assert\Email(array(
+                    'message' => 'The email "{{ value }}" is not a valid email.',
+                    'check'   => true,
+                )));
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/False.rst b/reference/constraints/False.rst
@@ -75,6 +75,20 @@ method returns **false**:
              }
         }
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Author.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Author
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addGetterConstraint('stateInvalid', new Assert\False());
+            }
+        }
+
 .. caution::
 
     When using YAML, be sure to surround ``False`` with quotes (``"False"``)
diff --git a/reference/constraints/File.rst b/reference/constraints/File.rst
@@ -116,15 +116,11 @@ below a certain file size and a valid PDF, add the following:
     .. code-block:: php
 
         // src/Acme/BlogBundle/Entity/Author.php
-        // ...
-
         use Symfony\Component\Validator\Mapping\ClassMetadata;
         use Symfony\Component\Validator\Constraints\File;
 
         class Author
         {
-            // ...
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('bioFile', new File(array(
@@ -231,4 +227,4 @@ for some unknown reason, such as the file upload failed or it couldn't be writte
 to disk.
 
 
-.. _`IANA website`: http://www.iana.org/assignments/media-types/index.html
+.. _`IANA website`: http://www.iana.org/assignments/media-types/index.html
diff --git a/reference/constraints/Ip.rst b/reference/constraints/Ip.rst
@@ -53,6 +53,22 @@ Basic Usage
             </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('ipAddress', new Assert\Ip());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Language.rst b/reference/constraints/Language.rst
@@ -50,6 +50,22 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/UserBundle/Entity/User.php
+        namespace Acme\UserBundle\Entity;
+        
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class User
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('preferredLanguage', new Assert\Language());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Locale.rst b/reference/constraints/Locale.rst
@@ -54,6 +54,22 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/UserBundle/Entity/User.php
+        namespace Acme\UserBundle\Entity;
+        
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+  
+        class User
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('locale', new Assert\Locale());
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/Max.rst b/reference/constraints/Max.rst
@@ -56,6 +56,23 @@ add the following:
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/EventBundle/Entity/Participant.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Participant
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('age', new Assert\Max(array(
+                    'limit'   => 50,
+                    'message' => "You must be 50 or under to enter.",
+                )));
+            }
+        }
+
 Options
 -------
 
@@ -81,4 +98,4 @@ invalidMessage
 **type**: ``string`` **default**: ``This value should be a valid number``
 
 The message that will be shown if the underlying value is not a number (per
-the :phpfunction:`is_numeric` PHP function).
+the :phpfunction:`is_numeric` PHP function).
diff --git a/reference/constraints/MinLength.rst b/reference/constraints/MinLength.rst
@@ -56,6 +56,23 @@ Basic Usage
             </property>
         </class>
 
+    .. code-block:: php
+
+        // src/Acme/BlogBundle/Entity/Blog.php
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Blog
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('summary', new Assert\MinLength(array(
+                    'limit'   => 3,
+                    'message' => 'Your name must have at least {{ limit }} characters.',
+                )));
+            }
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/NotBlank.rst b/reference/constraints/NotBlank.rst
diff --git a/reference/constraints/NotNull.rst b/reference/constraints/NotNull.rst
diff --git a/reference/constraints/Null.rst b/reference/constraints/Null.rst
diff --git a/reference/constraints/Regex.rst b/reference/constraints/Regex.rst
diff --git a/reference/constraints/Time.rst b/reference/constraints/Time.rst
diff --git a/reference/constraints/Type.rst b/reference/constraints/Type.rst
diff --git a/reference/constraints/Url.rst b/reference/constraints/Url.rst
