Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
[Validator] Add docs for bridge twig validator #20836#20863
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
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
63 changes: 63 additions & 0 deletionsbridge/twig/validation.rst
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,63 @@ | ||
Validating Twig Template Syntax | ||
=============================== | ||
The Twig Bridge provides a custom `Twig` constraint that allows validating | ||
whether a given string contains valid Twig syntax. | ||
This is particularly useful when template content is user-generated or | ||
configurable, and you want to ensure it can be safely rendered by the Twig engine. | ||
Installation | ||
------------ | ||
This constraint is part of the `symfony/twig-bridge` package. Make sure it's installed: | ||
.. code-block:: terminal | ||
$ composer require symfony/twig-bridge | ||
Usage | ||
----- | ||
To use the `Twig` constraint, annotate the property that should contain a valid | ||
Twig template:: | ||
use Symfony\Bridge\Twig\Validator\Constraints\Twig; | ||
class Template | ||
{ | ||
#[Twig] | ||
private string $templateCode; | ||
} | ||
If the template contains a syntax error, a validation error will be thrown. | ||
Constraint Options | ||
------------------ | ||
**message** | ||
Customize the default error message when the template is invalid:: | ||
// ... | ||
class Template | ||
{ | ||
#[Twig(message: 'Your template contains a syntax error.')] | ||
private string $templateCode; | ||
} | ||
**skipDeprecations** | ||
By default, this option is set to `true`, which means Twig deprecation warnings | ||
are ignored during validation. | ||
If you want validation to fail when deprecated features are used in the template, | ||
set this to `false`:: | ||
// ... | ||
class Template | ||
{ | ||
#[Twig(skipDeprecations: false)] | ||
private string $templateCode; | ||
} | ||
This can be helpful when enforcing stricter template rules or preparing for major | ||
Twig version upgrades. |
1 change: 1 addition & 0 deletionsindex.rst
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 |
---|---|---|
@@ -60,6 +60,7 @@ Topics | ||
web_link | ||
webhook | ||
workflow | ||
twig_bridge | ||
Components | ||
---------- | ||
9 changes: 9 additions & 0 deletionstwig_bridge.rst
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,9 @@ | ||
Twig Bridge | ||
=========== | ||
This bridge integrates Symfony with the Twig templating engine. | ||
.. toctree:: | ||
:maxdepth: 1 | ||
bridge/twig/validation |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.