Merge branch '2.1' into 2.2

Author: weaverryan

book/validation.rst

@@ -781,6 +781,9 @@ With this configuration, there are two validation groups:
 
 * ``Default`` - contains the constraints not assigned to any other group;
 
+* ``User`` - contains the constraints that belongs to group ``Default``
+ (this group is useful for :ref:`book-validation-group-sequence`);
+
 * ``registration`` - contains the constraints on the ``email`` and ``password``
  fields only.
 
@@ -789,13 +792,138 @@ as the second argument to the ``validate()`` method::
 
  $errors = $validator->validate($author, array('registration'));
 
+If no groups are specified, all constraints that belong in group ``Default``
+will be applied.
+
 Of course, you'll usually work with validation indirectly through the form
 library. For information on how to use validation groups inside forms, see
 :ref:`book-forms-validation-groups`.
 
 .. index::
  single: Validation; Validating raw values
 
+.. _book-validation-group-sequence:
+
+Group Sequence
+--------------
+
+In some cases, you want to validate your groups by steps. To do this, you can
+use the ``GroupSequence`` feature. In the case, an object defines a group sequence,
+and then the groups in the group sequence are validated in order.
+
+.. tip::
+
+ Group sequences cannot contain the group ``Default``, as this would create
+ a loop. Instead, use the group ``{ClassName}`` (e.g. ``User``) instead.
+
+For example, suppose you have a ``User`` class and want to validate that the
+username and the password are different only if all other validation passes
+(in order to avoid multiple error messages).
+
+.. configuration-block::
+
+ .. code-block:: yaml
+
+ # src/Acme/BlogBundle/Resources/config/validation.yml
+ Acme\BlogBundle\Entity\User:
+ group_sequence:
+ - User
+ - Strict
+ getters:
+ passwordLegal:
+ - "True":
+ message: "The password cannot match your username"
+ groups: [Strict]
+ properties:
+ username:
+ - NotBlank: ~
+ password:
+ - NotBlank: ~
+
+ .. code-block:: php-annotations
+
+ // src/Acme/BlogBundle/Entity/User.php
+ namespace Acme\BlogBundle\Entity;
+
+ use Symfony\Component\Security\Core\User\UserInterface;
+ use Symfony\Component\Validator\Constraints as Assert;
+
+ /**
+ * @Assert\GroupSequence({"Strict", "User"})
+ */
+ class User implements UserInterface
+ {
+ /**
+ * @Assert\NotBlank
+ */
+ private $username;
+
+ /**
+ * @Assert\NotBlank
+ */
+ private $password;
+
+ /**
+ * @Assert\True(message="The password cannot match your username", groups={"Strict"})
+ */
+ public function isPasswordLegal()
+ {
+ return ($this->username !== $this->password);
+ }
+ }
+
+ .. code-block:: xml
+
+ <!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
+ <class name="Acme\BlogBundle\Entity\User">
+ <property name="username">
+ <constraint name="NotBlank" />
+ </property>
+ <property name="password">
+ <constraint name="NotBlank" />
+ </property>
+ <getter property="passwordLegal">
+ <constraint name="True">
+ <option name="message">The password cannot match your username</option>
+ <option name="groups">
+ <value>Strict</value>
+ </option>
+ </constraint>
+ </getter>
+ <group-sequence>
+ <value>User</value>
+ <value>Strict</value>
+ </group-sequence>
+ </class>
+
+ .. code-block:: php
+
+ // src/Acme/BlogBundle/Entity/User.php
+ namespace Acme\BlogBundle\Entity;
+
+ use Symfony\Component\Validator\Mapping\ClassMetadata;
+ use Symfony\Component\Validator\Constraints as Assert;
+
+ class User
+ {
+ public static function loadValidatorMetadata(ClassMetadata $metadata)
+ {
+ $metadata->addPropertyConstraint('username', new Assert\NotBlank());
+ $metadata->addPropertyConstraint('password', new Assert\NotBlank());
+
+ $metadata->addGetterConstraint('passwordLegal', new Assert\True(array(
+ 'message' => 'The password cannot match your first name',
+ 'groups' => array('Strict'),
+ )));
+
+ $metadata->setGroupSequence(array('User', 'Strict'));
+ }
+ }
+
+In this example, it will first validate all constraints in the group ``User``
+(which is the same as the ``Default`` group). Only if all constraints in
+that group are valid, the second group, ``Strict``, will be validated.
+
 .. _book-validation-raw-values:
 
 Validating Values and Arrays

contributing/code/patches.rst

@@ -34,15 +34,15 @@ Set up your user information with your real name and a working email address:
 
 .. tip::
 
- If your IDE creates configuration files inside project's directory,
+ If your IDE creates configuration files inside the project's directory,
  you can use global ``.gitignore`` file (for all projects) or
  ``.git/info/exclude`` file (per project) to ignore them. See
  `Github's documentation`_.
 
 .. tip::
 
  Windows users: when installing Git, the installer will ask what to do with
- line endings and suggests to replace all Lf by CRLF. This is the wrong
+ line endings, and suggests replacing all LF with CRLF. This is the wrong
  setting if you wish to contribute to Symfony! Selecting the as-is method is
  your best choice, as git will convert your line feeds to the ones in the
  repository. If you have already installed Git, you can check the value of
@@ -52,8 +52,8 @@ Set up your user information with your real name and a working email address:
 
  $ git config core.autocrlf
 
- This will return either "false", "input" or "true", "true" and "false" being
- the wrong values. Set it to another value by typing:
+ This will return either "false", "input" or "true"; "true" and "false" being
+ the wrong values. Change it to "input" by typing:
 
  .. code-block:: bash
 
@@ -344,7 +344,7 @@ because you want early feedback on your work, add an item to todo-list:
 .. code-block:: text
 
  - [ ] finish the code
- - [ ] gather feedback my changes
+ - [ ] gather feedback for my changes
 
 As long as you have items in the todo-list, please prefix the pull request
 title with "[WIP]".

contributing/code/standards.rst

@@ -49,11 +49,11 @@ example containing most features described below:
 
  /**
  * @param string $dummy Some argument description
- * @param array $options
+ * @param array  $options
  *
  * @return string|null Transformed input
  */
- private function transformText($dummy, $options = array())
+ private function transformText($dummy, array $options = array())
  {
  $mergedOptions = array_merge(
  $options,

reference/dic_tags.rst

@@ -194,7 +194,7 @@ Finally, apply the filter:
 You can also apply your filter via the ``assetic.filters.my_filter.apply_to``
 config option as it's described here: :doc:`/cookbook/assetic/apply_to_option`.
 In order to do that, you must define your filter service in a separate xml
-config file and point to this file's via the ``assetic.filters.my_filter.resource``
+config file and point to this file's path via the ``assetic.filters.my_filter.resource``
 configuration key.
 
 assetic.formula_loader

reference/forms/types/options/max_length.rst.inc

@@ -3,5 +3,5 @@ max_length
 
 **type**: ``integer``
 
-This option is used to add a ``max_length`` attribute, which is used by
-some browsers to limit the amount of text in a field.
+This option is used to add a ``maxlength`` attribute, which is used by
+some browsers to limit the amount of text in a field.