-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Validator] Add Cascade
constraint documentation
#17984
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.
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
javiereguiluz
merged 1 commit into
symfony:5.4
from
alexandre-daubois:cascade-constraint
Mar 2, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
Cascade | ||
======= | ||
|
||
.. versionadded:: 5.2 | ||
|
||
The :class:`Symfony\\Component\\Validator\\Constraints\\Cascade` was | ||
introduced in Symfony 5.2 and requires PHP 7.4. | ||
|
||
The Cascade constraint is used to validate a whole class. It allows to | ||
omit to add the :doc:`/reference/constraints/Valid` constraint on each | ||
child object of your class you want to validate. | ||
|
||
========== =================================================================== | ||
Applies to :ref:`class <validation-class-target>` | ||
Class :class:`Symfony\\Component\\Validator\\Constraints\\Cascade` | ||
========== =================================================================== | ||
|
||
Basic Usage | ||
----------- | ||
|
||
In the following example, the | ||
:class:`Symfony\\Component\\Validator\\Constraints\\Cascade` constraint | ||
will tell the validator to validate all fields of the class, including | ||
constraints that are set in the child classes ``BookMetadata`` and | ||
``Author``: | ||
|
||
.. configuration-block:: | ||
|
||
.. code-block:: php-annotations | ||
|
||
// src/Model/BookCollection.php | ||
namespace App\Model; | ||
|
||
use App\Model\Author; | ||
use App\Model\BookMetadata; | ||
use Symfony\Component\Validator\Constraints as Assert; | ||
|
||
/** | ||
* @Assert\Cascade | ||
*/ | ||
class BookCollection | ||
{ | ||
/** | ||
* @Assert\NotBlank | ||
*/ | ||
protected $name = ''; | ||
|
||
public BookMetadata $metadata; | ||
|
||
public Author $author; | ||
|
||
// ... | ||
} | ||
|
||
.. code-block:: php-attributes | ||
|
||
// src/Model/BookCollection.php | ||
namespace App\Model; | ||
|
||
use App\Model\Author; | ||
use App\Model\BookMetadata; | ||
use Symfony\Component\Validator\Constraints as Assert; | ||
|
||
#[Assert\Cascade] | ||
class BookCollection | ||
{ | ||
#[Assert\NotBlank] | ||
protected $name = ''; | ||
|
||
public BookMetadata $metadata; | ||
|
||
public Author $author; | ||
|
||
// ... | ||
} | ||
|
||
.. code-block:: yaml | ||
|
||
# config/validator/validation.yaml | ||
App\Entity\BookCollection: | ||
constraints: | ||
- Cascade: ~ | ||
|
||
.. code-block:: xml | ||
|
||
<!-- config/validator/validation.xml --> | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> | ||
|
||
<class name="App\Entity\BookCollection"> | ||
<constraint name="Cascade"/> | ||
</class> | ||
</constraint-mapping> | ||
|
||
.. code-block:: php | ||
|
||
// src/Entity/BookCollection.php | ||
namespace App\Entity; | ||
|
||
use Symfony\Component\Validator\Constraints as Assert; | ||
use Symfony\Component\Validator\Mapping\ClassMetadata; | ||
|
||
class BookCollection | ||
{ | ||
// ... | ||
|
||
public static function loadValidatorMetadata(ClassMetadata $metadata) | ||
{ | ||
$metadata->addConstraint(new Assert\Cascade()); | ||
} | ||
} | ||
|
||
Options | ||
------- | ||
|
||
The ``groups`` option is not available for this constraint. | ||
|
||
.. include:: /reference/constraints/_payload-option.rst.inc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.