diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #36056 [Security/Core] fix some annotations (nicolas-grekas)

Browse Source 
This PR was merged into the 3.4 branch.

Discussion
----------

[Security/Core] fix some annotations

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | -

`RoleInterface` is deprecated, and we don't document deprecated ways in docblocks/exceptions.

Commits
-------

8e873d0b5b [Security/Core] fix some annotations
This commit is contained in:
Nicolas Grekas 2020-03-13 11:22:53 +01:00
commit f6f19e6c00
5 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php
View File

@ -31,7 +31,7 @@ abstract class AbstractToken implements TokenInterface
private $attributes = []; private $attributes = [];
/** /**
* @param (RoleInterface|string)[] $roles An array of roles * @param (Role|string)[] $roles An array of roles
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
*/ */
@ -41,7 +41,7 @@ abstract class AbstractToken implements TokenInterface
if (\is_string($role)) { if (\is_string($role)) {
$role = new Role($role); $role = new Role($role);
} elseif (!$role instanceof RoleInterface) { } elseif (!$role instanceof RoleInterface) {
throw new \InvalidArgumentException(sprintf('$roles must be an array of strings, Role instances or RoleInterface instances, but got %s.', \gettype($role))); throw new \InvalidArgumentException(sprintf('$roles must be an array of strings, Role instances, but got %s.', \gettype($role)));
} }
$this->roles[] = $role; $this->roles[] = $role;

7
src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php
View File

@ -12,6 +12,7 @@
namespace Symfony\Component\Security\Core\Authentication\Token; namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\Role; use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\UserInterface;
/** /**
* AnonymousToken represents an anonymous token. * AnonymousToken represents an anonymous token.
@ -23,9 +24,9 @@ class AnonymousToken extends AbstractToken
private $secret; private $secret;
/** /**
* @param string $secret A secret used to make sure the token is created by the app and not by a malicious client * @param string $secret A secret used to make sure the token is created by the app and not by a malicious client
* @param string|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string * @param string|\Stringable|UserInterface $user
* @param Role[] $roles An array of roles * @param (Role|string)[] $roles
*/ */
public function __construct($secret, $user, array $roles = []) public function __construct($secret, $user, array $roles = [])
{ {

11
src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php
View File

@ -11,7 +11,8 @@
namespace Symfony\Component\Security\Core\Authentication\Token; namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\RoleInterface; use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\UserInterface;
/** /**
* PreAuthenticatedToken implements a pre-authenticated token. * PreAuthenticatedToken implements a pre-authenticated token.
@ -24,10 +25,10 @@ class PreAuthenticatedToken extends AbstractToken
private $providerKey; private $providerKey;
/** /**
* @param string|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string * @param string|\Stringable|UserInterface $user
* @param mixed $credentials The user credentials * @param mixed $credentials
* @param string $providerKey The provider key * @param string $providerKey
* @param (RoleInterface|string)[] $roles An array of roles * @param (Role|string)[] $roles
*/ */
public function __construct($user, $credentials, $providerKey, array $roles = []) public function __construct($user, $credentials, $providerKey, array $roles = [])
{ {

6
src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php
View File

@ -12,6 +12,7 @@
namespace Symfony\Component\Security\Core\Authentication\Token; namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\RoleInterface; use Symfony\Component\Security\Core\Role\RoleInterface;
use Symfony\Component\Security\Core\User\UserInterface;
/** /**
* TokenInterface is the interface for the user authentication information. * TokenInterface is the interface for the user authentication information.
@ -47,8 +48,7 @@ interface TokenInterface extends \Serializable
/** /**
* Returns a user representation. * Returns a user representation.
* *
* @return string|object Can be a UserInterface instance, an object implementing a __toString method, * @return string|\Stringable|UserInterface
* or the username as a regular string
* *
* @see AbstractToken::setUser() * @see AbstractToken::setUser()
*/ */
@ -60,7 +60,7 @@ interface TokenInterface extends \Serializable
* The user can be a UserInterface instance, or an object implementing * The user can be a UserInterface instance, or an object implementing
* a __toString method or the username as a regular string. * a __toString method or the username as a regular string.
* *
* @param string|object $user The user * @param string|\Stringable|UserInterface $user
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
*/ */

11
src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php
View File

@ -11,7 +11,8 @@
namespace Symfony\Component\Security\Core\Authentication\Token; namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\RoleInterface; use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\UserInterface;
/** /**
* UsernamePasswordToken implements a username and password token. * UsernamePasswordToken implements a username and password token.
@ -24,10 +25,10 @@ class UsernamePasswordToken extends AbstractToken
private $providerKey; private $providerKey;
/** /**
* @param string|object $user The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method * @param string|\Stringable|UserInterface $user The username (like a nickname, email address, etc.) or a UserInterface instance
* @param mixed $credentials This usually is the password of the user * @param mixed $credentials
* @param string $providerKey The provider key * @param string $providerKey
* @param (RoleInterface|string)[] $roles An array of roles * @param (Role|string)[] $roles
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
*/ */