4668 document isCsrfTokenValid #5325
Closed
Conversation
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
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | yes |
| Applies to | 2.6 |
| Fixed tickets | #4668 |
|
|
||
| if ($this->isCsrfTokenValid('token_id', 'TOKEN')) { | ||
| // ... do something, like deleting an object | ||
| } |
There was a problem hiding this comment.
For consistency with other parts of the doc, there should be a comment showing the alternative not using the shortcut
| } | ||
|
|
||
| .. versionadded:: 2.6 | ||
| The ``isCsrfTokenValid()`` shortcut method was added in Symfony 2.6. |
There was a problem hiding this comment.
We always use "was introduced in".
|
@snoek09 Thank you for your contribution. Do you also like to open a pull request for the |
| Sometimes you want to use CSRF protection in an action where you don't want to use a | ||
| Symfony form. | ||
|
|
||
| If, for example, you're doing a DELETE action, you can use the :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::isCsrfTokenValid` |
There was a problem hiding this comment.
Can you please move the method role to its own line?
|
@xabbuh done, please let me know if this needs any other changes. |
| } | ||
|
|
||
| .. versionadded:: 2.6 | ||
| The ``isCsrfTokenValid()`` shortcut method was introduced in Symfony 2.6. |
There was a problem hiding this comment.
I prefer something like this:
.. versionadded:: 2.6
The ``isCsrfTokenValid()`` shortcut method was introduced in Symfony 2.6.
It is equivalent to executing the following code::
use Symfony\Component\Security\Csrf\CsrfToken;
$this->get('security.csrf.token_manager')->isTokenValid(new CsrfToken('token_id', 'TOKEN'));|
👍 (apart from my 2 comments, but these can be fixed by the merger quite easily) |
wouterj
added a commit
that referenced
this pull request
Jul 29, 2015
This PR was squashed before being merged into the 2.6 branch (closes #5572). Discussion ---------- 4668 document isCsrfTokenValid | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | 2.6 | Fixed tickets | #4668 See original PR #5325 for comments. Commits ------- 11383f8 4668 document isCsrfTokenValid
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.