Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
[Validator] Deprecate constraint "ExpressionLanguageSyntax", use "ExpressionSyntax" instead#16786
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
javiereguiluz merged 1 commit intosymfony:6.1frommpiot:deprecate-expression-language-syntaxMay 23, 2022
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
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
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
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,147 @@ | ||
| ExpressionSyntax | ||
| ================ | ||
| This constraint checks that the value is valid as an `ExpressionLanguage`_ | ||
| expression. | ||
| .. info:: 6.1 | ||
| This constraint is deprecated since Symfony 6.1. | ||
| Use the``ExpressionSyntax`` constraint instead. | ||
| ========== =================================================================== | ||
| Applies to :ref:`property or method <validation-property-target>` | ||
| Class :class:`Symfony\\Component\\Validator\\Constraints\\ExpressionSyntax` | ||
| Validator :class:`Symfony\\Component\\Validator\\Constraints\\ExpressionSyntaxValidator` | ||
| ========== =================================================================== | ||
| Basic Usage | ||
| ----------- | ||
| The following constraints ensure that: | ||
| * the ``promotion`` property stores a value which is valid as an | ||
| ExpressionLanguage expression; | ||
| * the ``shippingOptions`` property also ensures that the expression only uses | ||
| certain variables. | ||
| .. configuration-block:: | ||
| .. code-block:: php-annotations | ||
| // src/Entity/Order.php | ||
| namespace App\Entity; | ||
| use Symfony\Component\Validator\Constraints as Assert; | ||
| class Order | ||
| { | ||
| /** | ||
| * @Assert\ExpressionSyntax | ||
| */ | ||
| protected $promotion; | ||
| /** | ||
| * @Assert\ExpressionSyntax( | ||
| * allowedVariables={"user", "shipping_centers"} | ||
| * ) | ||
| */ | ||
| protected $shippingOptions; | ||
| } | ||
| .. code-block:: php-attributes | ||
| // src/Entity/Order.php | ||
| namespace App\Entity; | ||
| use Symfony\Component\Validator\Constraints as Assert; | ||
| class Order | ||
| { | ||
| #[Assert\ExpressionSyntax] | ||
| protected $promotion; | ||
| #[Assert\ExpressionSyntax( | ||
| allowedVariables: ['user', 'shipping_centers'], | ||
| )] | ||
| protected $shippingOptions; | ||
| } | ||
| .. code-block:: yaml | ||
| # config/validator/validation.yaml | ||
| App\Entity\Order: | ||
| properties: | ||
| promotion: | ||
| - ExpressionSyntax: ~ | ||
| shippingOptions: | ||
| - ExpressionSyntax: | ||
| allowedVariables: ['user', 'shipping_centers'] | ||
| .. 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\Order"> | ||
| <property name="promotion"> | ||
| <constraint name="ExpressionSyntax"/> | ||
| </property> | ||
| <property name="shippingOptions"> | ||
| <constraint name="ExpressionSyntax"> | ||
| <option name="allowedVariables"> | ||
| <value>user</value> | ||
| <value>shipping_centers</value> | ||
| </option> | ||
| </constraint> | ||
| </property> | ||
| </class> | ||
| </constraint-mapping> | ||
| .. code-block:: php | ||
| // src/Entity/Student.php | ||
| namespace App\Entity; | ||
| use Symfony\Component\Validator\Constraints as Assert; | ||
| use Symfony\Component\Validator\Mapping\ClassMetadata; | ||
| class Order | ||
| { | ||
| public static function loadValidatorMetadata(ClassMetadata $metadata) | ||
| { | ||
| $metadata->addPropertyConstraint('promotion', new Assert\ExpressionSyntax()); | ||
| $metadata->addPropertyConstraint('shippingOptions', new Assert\ExpressionSyntax([ | ||
| 'allowedVariables' => ['user', 'shipping_centers'], | ||
| ])); | ||
| } | ||
| } | ||
| Options | ||
| ------- | ||
| allowedVariables | ||
| ~~~~~~~~~~~~~~~~ | ||
| **type**: ``array`` or ``null`` **default**: ``null`` | ||
| If this option is defined, the expression can only use the variables whose names | ||
| are included in this option. Unset this option or set its value to ``null`` to | ||
| allow any variables. | ||
| .. include:: /reference/constraints/_groups-option.rst.inc | ||
| message | ||
| ~~~~~~~ | ||
| **type**: ``string`` **default**: ``This value should be a valid expression.`` | ||
| This is the message displayed when the validation fails. | ||
| .. include:: /reference/constraints/_payload-option.rst.inc | ||
| .. _`ExpressionLanguage`: https://symfony.com/components/ExpressionLanguage |
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.