minor #10840 [Security] fixed wrong PHPDoc of the TokenGeneratorInterface (hhamon)

This PR was merged into the 2.4 branch.

Discussion
----------

[Security] fixed wrong PHPDoc of the TokenGeneratorInterface

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| License       | MIT

Commits
-------

0e32676 [Security] fixed wrong PHPDoc of the TokenGeneratorInterface
This commit is contained in:
Fabien Potencier 2014-05-02 17:36:34 +02:00
commit b3ec567224

View File

@ -12,19 +12,7 @@
namespace Symfony\Component\Security\Csrf\TokenGenerator;
/**
* Generates and validates CSRF tokens.
*
* You can generate a CSRF token by using the method {@link generateCsrfToken()}.
* This method expects a unique token ID as argument. The token ID can later be
* used to validate a token provided by the user.
*
* Token IDs do not necessarily have to be secret, but they should NEVER be
* created from data provided by the client. A good practice is to hard-code the
* token IDs for the various CSRF tokens used by your application.
*
* You should use the method {@link isCsrfTokenValid()} to check a CSRF token
* submitted by the client. This method will return true if the CSRF token is
* valid.
* Generates CSRF tokens.
*
* @since 2.4
* @author Bernhard Schussek <bschussek@gmail.com>