minor #27940 [Security] Update user phpdoc on tokens (ro0NL)

This PR was squashed before being merged into the 2.8 branch (closes #27940).

Discussion
----------

[Security] Update user phpdoc on tokens

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | #...   <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!-- required for new features -->

As implemented here:

1e16a8b979/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php (L78-L88)

Note IMHO `string|object` is intended, and used consistently elsewhere, e.g.: f80376217d/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php (L27)

Commits
-------

7306018a30 [Security] Update user phpdoc on tokens
This commit is contained in:
Fabien Potencier 2018-07-13 22:20:16 +02:00
commit 091f9ff386
2 changed files with 10 additions and 12 deletions

View File

@ -77,14 +77,7 @@ abstract class AbstractToken implements TokenInterface
}
/**
* Sets the user in the token.
*
* The user can be a UserInterface instance, or an object implementing
* a __toString method or the username as a regular string.
*
* @param string|object $user The user
*
* @throws \InvalidArgumentException
* {@inheritdoc}
*/
public function setUser($user)
{

View File

@ -47,17 +47,22 @@ interface TokenInterface extends \Serializable
/**
* Returns a user representation.
*
* @return mixed Can be a UserInterface instance, an object implementing a __toString method,
* or the username as a regular string
* @return string|object Can be a UserInterface instance, an object implementing a __toString method,
* or the username as a regular string
*
* @see AbstractToken::setUser()
*/
public function getUser();
/**
* Sets a user.
* Sets the user in the token.
*
* @param mixed $user
* The user can be a UserInterface instance, or an object implementing
* a __toString method or the username as a regular string.
*
* @param string|object $user The user
*
* @throws \InvalidArgumentException
*/
public function setUser($user);