Skip to content

Validator Documentation for Collection constraint Required/Optional options #2432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 9, 2013
Merged

Validator Documentation for Collection constraint Required/Optional options #2432

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
779f0e7
Add documentation to Collection constraint showing usage of Required
Mar 30, 2013
a7e150a
Fix missing line breaks and heading line length.
Mar 30, 2013
b659e24
Change complete to completely.
Mar 31, 2013
e83d16f
Added configuration-block:: annotation to example section.
Mar 31, 2013
3f38483
Update Collection.rst
benglass Apr 1, 2013
2938e6c
Update Collection.rst
benglass Apr 1, 2013
f826f60
Update Collection.rst
benglass Apr 1, 2013
2d4eb95
Update Collection.rst
benglass Apr 1, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions reference/constraints/Collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,72 @@ the above example, the ``allowMissingFields`` option was set to true, meaning
that if either of the ``personal_email`` or ``short_bio`` elements were missing
from the ``$personalData`` property, no validation error would occur.

.. versionadded:: 2.1
The ``Required`` and ``Optional`` constraints are new to Symfony 2.1.

Required and Optional Field Constraints
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Constraints for fields within a collection can be wrapped in the ``Required`` or
``Optional`` constraint to control whether they should always be applied (``Required``)
or only applied when the field is present (``Optional``).

For instance, if you want to require that the ``personal_email`` field of the
``profileData`` array is not blank and is a valid email but the ``alternate_email``
field is optional but must be a valid email if supplied, you can do the following:

.. configuration-block::

.. code-block:: php-annotations

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
/**
* @Assert\Collection(
* fields={
* "personal_email" = @Assert\Collection\Required({@Assert\NotBlank, @Assert\Email}),
* "alternate_email" = @Assert\Collection\Optional({@Assert\Email}),
* }
* )
*/
protected $profileData = array(
'personal_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
{
protected $profileData = array('personal_email');

public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('profileData', new Assert\Collection(array(
'fields' => array(
'personal_email' => new Assert\Collection\Required(array(new Assert\NotBlank(), new Assert\Email())),
'alternate_email' => new Assert\Collection\Optional(array(new Assert\Email())),
),
)));
}
}

Even without ``allowMissingFields`` set to true, you can now omit the ``alternate_email`` property
completely from the ``profileData`` array, since it is ``Optional``. However, if the the ``personal_email``
field does not exist in the array there will be a constraint violation that the field is missing,
since it is ``Required``.

Options
-------

Expand Down