minor #11366 streamline the constraints reference (OskarStark)

javiereguiluz · javiereguiluz · commit 41fa05eb5db5 · 2019-04-09T11:02:44.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- streamline the constraints reference I felt the constraints need some love 💟 Commits ------- ce77fdb streamline the constraints reference
diff --git a/reference/constraints/All.rst b/reference/constraints/All.rst
@@ -39,7 +39,7 @@ entry in that array:
              *     @Assert\Length(min=5)
              * })
              */
-             protected $favoriteColors = [];
+            protected $favoriteColors = [];
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Bic.rst b/reference/constraints/Bic.rst
@@ -73,8 +73,6 @@ will contain a Business Identifier Code (BIC).
 
         class Transaction
         {
-            protected $businessIdentifierCode;
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('businessIdentifierCode', new Assert\Bic());
diff --git a/reference/constraints/Callback.rst b/reference/constraints/Callback.rst
@@ -87,6 +87,11 @@ Configuration
             {
                 $metadata->addConstraint(new Assert\Callback('validate'));
             }
+
+            public function validate(ExecutionContextInterface $context, $payload)
+            {
+                // ...
+            }
         }
 
 The Callback Method
diff --git a/reference/constraints/CardScheme.rst b/reference/constraints/CardScheme.rst
@@ -84,8 +84,6 @@ on an object that will contain a credit card number.
 
         class Transaction
         {
-            protected $cardNumber;
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('cardNumber', new Assert\CardScheme([
diff --git a/reference/constraints/Choice.rst b/reference/constraints/Choice.rst
@@ -112,8 +112,6 @@ If your valid choice list is simple, you can pass them in directly via the
 
         class Author
         {
-            protected $genre;
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint(
diff --git a/reference/constraints/Collection.rst b/reference/constraints/Collection.rst
@@ -141,8 +141,6 @@ following:
 
         class Author
         {
-            private $options = [];
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('profileData', new Assert\Collection([
@@ -208,7 +206,7 @@ you can do the following:
              *     }
              * )
              */
-             protected $profileData = ['personal_email'];
+            protected $profileData = ['personal_email'];
         }
 
     .. code-block:: yaml
@@ -272,9 +270,10 @@ you can do the following:
             {
                 $metadata->addPropertyConstraint('profileData', new Assert\Collection([
                     'fields' => [
-                        'personal_email'  => new Assert\Required(
-                            [new Assert\NotBlank(), new Assert\Email()]
-                        ),
+                        'personal_email'  => new Assert\Required([
+                            new Assert\NotBlank(),
+                            new Assert\Email(),
+                        ]),
                         'alternate_email' => new Assert\Optional(new Assert\Email()),
                     ],
                 ]));
diff --git a/reference/constraints/Count.rst b/reference/constraints/Count.rst
@@ -45,7 +45,7 @@ you might add the following:
              *      maxMessage = "You cannot specify more than {{ limit }} emails"
              * )
              */
-             protected $emails = [];
+            protected $emails = [];
         }
 
     .. code-block:: yaml
@@ -93,8 +93,8 @@ you might add the following:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('emails', new Assert\Count([
-                    'min'        => 1,
-                    'max'        => 5,
+                    'min' => 1,
+                    'max' => 5,
                     'minMessage' => 'You must specify at least one email',
                     'maxMessage' => 'You cannot specify more than {{ limit }} emails',
                 ]));
diff --git a/reference/constraints/Country.rst b/reference/constraints/Country.rst
@@ -32,7 +32,7 @@ Basic Usage
             /**
              * @Assert\Country
              */
-             protected $country;
+            protected $country;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Date.rst b/reference/constraints/Date.rst
@@ -34,7 +34,7 @@ Basic Usage
             /**
              * @Assert\Date
              */
-             protected $birthday;
+            protected $birthday;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/DateTime.rst b/reference/constraints/DateTime.rst
@@ -35,7 +35,7 @@ Basic Usage
             /**
              * @Assert\DateTime
              */
-             protected $createdAt;
+            protected $createdAt;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Email.rst b/reference/constraints/Email.rst
@@ -39,7 +39,7 @@ Basic Usage
              *     checkMX = true
              * )
              */
-             protected $email;
+            protected $email;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Image.rst b/reference/constraints/Image.rst
@@ -211,13 +211,11 @@ following code:
 
         class Author
         {
-            // ...
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('headshot', new Assert\Image([
-                    'allowLandscape'    => false,
-                    'allowPortrait'     => false,
+                    'allowLandscape' => false,
+                    'allowPortrait' => false,
                 ]));
             }
         }
diff --git a/reference/constraints/Ip.rst b/reference/constraints/Ip.rst
@@ -35,7 +35,7 @@ Basic Usage
             /**
              * @Assert\Ip
              */
-             protected $ipAddress;
+            protected $ipAddress;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/IsFalse.rst b/reference/constraints/IsFalse.rst
@@ -55,10 +55,10 @@ method returns **false**:
              *     message = "You've entered an invalid state."
              * )
              */
-             public function isStateInvalid()
-             {
+            public function isStateInvalid()
+            {
                 // ...
-             }
+            }
         }
 
     .. code-block:: yaml
@@ -99,10 +99,17 @@ method returns **false**:
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
-                $metadata->addGetterConstraint('stateInvalid', new Assert\IsFalse());
+                $metadata->addGetterConstraint('stateInvalid', new Assert\IsFalse([
+                    'message' => 'You've entered an invalid state.',
+                ]));
             }
         }
 
+        public function isStateInvalid()
+        {
+            // ...
+        }
+
 Options
 -------
 
diff --git a/reference/constraints/IsTrue.rst b/reference/constraints/IsTrue.rst
@@ -56,7 +56,7 @@ Then you can constrain this method with ``IsTrue``.
             protected $token;
 
             /**
-             * @Assert\IsTrue(message="The token is invalid")
+             * @Assert\IsTrue(message="The token is invalid.")
              */
             public function isTokenValid()
             {
@@ -100,8 +100,6 @@ Then you can constrain this method with ``IsTrue``.
 
         class Author
         {
-            protected $token;
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addGetterConstraint('tokenValid', new IsTrue([
diff --git a/reference/constraints/Isbn.rst b/reference/constraints/Isbn.rst
@@ -84,12 +84,10 @@ on an object that will contain an ISBN.
 
         class Book
         {
-            protected $isbn;
-
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('isbn', new Assert\Isbn([
-                    'type'    => 'isbn10',
+                    'type' => 'isbn10',
                     'message' => 'This value is not valid.',
                 ]));
             }
diff --git a/reference/constraints/Issn.rst b/reference/constraints/Issn.rst
@@ -35,7 +35,7 @@ Basic Usage
             /**
              * @Assert\Issn
              */
-             protected $issn;
+            protected $issn;
         }
 
     .. code-block:: yaml
@@ -87,7 +87,7 @@ Options
 message
 ~~~~~~~
 
-**type**: ``String`` default: ``This value is not a valid ISSN.``
+**type**: ``string`` default: ``This value is not a valid ISSN.``
 
 The message shown if the given value is not a valid ISSN.
 
diff --git a/reference/constraints/Language.rst b/reference/constraints/Language.rst
@@ -33,7 +33,7 @@ Basic Usage
             /**
              * @Assert\Language
              */
-             protected $preferredLanguage;
+            protected $preferredLanguage;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Length.rst b/reference/constraints/Length.rst
@@ -52,7 +52,7 @@ and "50", you might add the following:
              *      maxMessage = "Your first name cannot be longer than {{ limit }} characters"
              * )
              */
-             protected $firstName;
+            protected $firstName;
         }
 
     .. code-block:: yaml
@@ -104,8 +104,8 @@ and "50", you might add the following:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('firstName', new Assert\Length([
-                    'min'        => 2,
-                    'max'        => 50,
+                    'min' => 2,
+                    'max' => 50,
                     'minMessage' => 'Your first name must be at least {{ limit }} characters long',
                     'maxMessage' => 'Your first name cannot be longer than {{ limit }} characters',
                 ]));
diff --git a/reference/constraints/Locale.rst b/reference/constraints/Locale.rst
@@ -37,7 +37,7 @@ Basic Usage
             /**
              * @Assert\Locale
              */
-             protected $locale;
+            protected $locale;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Range.rst b/reference/constraints/Range.rst
@@ -92,8 +92,8 @@ you might add the following:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('height', new Assert\Range([
-                    'min'        => 120,
-                    'max'        => 180,
+                    'min' => 120,
+                    'max' => 180,
                     'minMessage' => 'You must be at least {{ limit }}cm tall to enter',
                     'maxMessage' => 'You cannot be taller than {{ limit }}cm to enter',
                 ]));
diff --git a/reference/constraints/Regex.rst b/reference/constraints/Regex.rst
@@ -156,7 +156,7 @@ it a custom message:
             {
                 $metadata->addPropertyConstraint('firstName', new Assert\Regex([
                     'pattern' => '/\d/',
-                    'match'   => false,
+                    'match' => false,
                     'message' => 'Your name cannot contain a number',
                 ]));
             }
@@ -257,7 +257,7 @@ need to specify the HTML5 compatible pattern in the ``htmlPattern`` option:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addPropertyConstraint('name', new Assert\Regex([
-                    'pattern'     => '/^[a-z]+$/i',
+                    'pattern' => '/^[a-z]+$/i',
                     'htmlPattern' => '^[a-zA-Z]+$',
                 ]));
             }
diff --git a/reference/constraints/Time.rst b/reference/constraints/Time.rst
@@ -37,7 +37,7 @@ of the day when the event starts:
             /**
              * @Assert\Time
              */
-             protected $startsAt;
+            protected $startsAt;
         }
 
     .. code-block:: yaml
diff --git a/reference/constraints/Type.rst b/reference/constraints/Type.rst
@@ -100,7 +100,7 @@ This will check if ``firstName`` is of type ``string`` and that ``age`` is an
                 $metadata->addPropertyConstraint('firstName', new Assert\Type('string'));
 
                 $metadata->addPropertyConstraint('age', new Assert\Type([
-                    'type'    => 'integer',
+                    'type' => 'integer',
                     'message' => 'The value {{ value }} is not a valid {{ type }}.',
                 ]));
             }
diff --git a/reference/constraints/UniqueEntity.rst b/reference/constraints/UniqueEntity.rst
@@ -51,14 +51,10 @@ your user table:
         class Author
         {
             /**
-             * @var string $email
-             *
              * @ORM\Column(name="email", type="string", length=255, unique=true)
              * @Assert\Email
              */
             protected $email;
-
-            // ...
         }
 
     .. code-block:: yaml
@@ -104,7 +100,7 @@ your user table:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addConstraint(new UniqueEntity([
-                    'fields'  => 'email',
+                    'fields' => 'email',
                 ]));
 
                 $metadata->addPropertyConstraint('email', new Assert\Email());
@@ -285,9 +281,9 @@ Consider this example:
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
                 $metadata->addConstraint(new UniqueEntity([
-                    'fields'    => ['host', 'port'],
+                    'fields' => ['host', 'port'],
                     'errorPath' => 'port',
-                    'message'   => 'This port is already in use on that host.',
+                    'message' => 'This port is already in use on that host.',
                 ]));
             }
         }
diff --git a/reference/constraints/Url.rst b/reference/constraints/Url.rst
diff --git a/reference/constraints/UserPassword.rst b/reference/constraints/UserPassword.rst
diff --git a/reference/constraints/Uuid.rst b/reference/constraints/Uuid.rst
diff --git a/reference/constraints/Valid.rst b/reference/constraints/Valid.rst

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ entry in that array:`
`39`	`39`	`* @Assert\Length(min=5)`
`40`	`40`	`* })`
`41`	`41`	`*/`
`42`		`- protected $favoriteColors = [];`
	`42`	`+ protected $favoriteColors = [];`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`.. code-block:: yaml`
Original file line number	Diff line number	Diff line change
`@@ -73,8 +73,6 @@ will contain a Business Identifier Code (BIC).`
`73`	`73`
`74`	`74`	`class Transaction`
`75`	`75`	`{`
`76`		`- protected $businessIdentifierCode;`
`77`		`-`
`78`	`76`	`public static function loadValidatorMetadata(ClassMetadata $metadata)`
`79`	`77`	`{`
`80`	`78`	`$metadata->addPropertyConstraint('businessIdentifierCode', new Assert\Bic());`
Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,11 @@ Configuration`
`87`	`87`	`{`
`88`	`88`	`$metadata->addConstraint(new Assert\Callback('validate'));`
`89`	`89`	`}`
	`90`	`+`
	`91`	`+ public function validate(ExecutionContextInterface $context, $payload)`
	`92`	`+ {`
	`93`	`+ // ...`
	`94`	`+ }`
`90`	`95`	`}`
`91`	`96`
`92`	`97`	`The Callback Method`
Original file line number	Diff line number	Diff line change
`@@ -84,8 +84,6 @@ on an object that will contain a credit card number.`
`84`	`84`
`85`	`85`	`class Transaction`
`86`	`86`	`{`
`87`		`- protected $cardNumber;`
`88`		`-`
`89`	`87`	`public static function loadValidatorMetadata(ClassMetadata $metadata)`
`90`	`88`	`{`
`91`	`89`	`$metadata->addPropertyConstraint('cardNumber', new Assert\CardScheme([`
Original file line number	Diff line number	Diff line change
`@@ -112,8 +112,6 @@ If your valid choice list is simple, you can pass them in directly via the`
`112`	`112`
`113`	`113`	`class Author`
`114`	`114`	`{`
`115`		`- protected $genre;`
`116`		`-`
`117`	`115`	`public static function loadValidatorMetadata(ClassMetadata $metadata)`
`118`	`116`	`{`
`119`	`117`	`$metadata->addPropertyConstraint(`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ Basic Usage`
`32`	`32`	`/**`
`33`	`33`	`* @Assert\Country`
`34`	`34`	`*/`
`35`		`- protected $country;`
	`35`	`+ protected $country;`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`.. code-block:: yaml`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ Basic Usage`
`34`	`34`	`/**`
`35`	`35`	`* @Assert\Date`
`36`	`36`	`*/`
`37`		`- protected $birthday;`
	`37`	`+ protected $birthday;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`.. code-block:: yaml`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ Basic Usage`
`35`	`35`	`/**`
`36`	`36`	`* @Assert\DateTime`
`37`	`37`	`*/`
`38`		`- protected $createdAt;`
	`38`	`+ protected $createdAt;`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`.. code-block:: yaml`