From 8e873d0b5be64f88b10ba7996300146770f29d1b Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Fri, 13 Mar 2020 10:53:59 +0100 Subject: [PATCH] [Security/Core] fix some annotations --- .../Core/Authentication/Token/AbstractToken.php | 4 ++-- .../Core/Authentication/Token/AnonymousToken.php | 7 ++++--- .../Authentication/Token/PreAuthenticatedToken.php | 11 ++++++----- .../Core/Authentication/Token/TokenInterface.php | 6 +++--- .../Authentication/Token/UsernamePasswordToken.php | 11 ++++++----- 5 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php index 9d5a01d942..d10b938bf0 100644 --- a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php +++ b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php @@ -31,7 +31,7 @@ abstract class AbstractToken implements TokenInterface private $attributes = []; /** - * @param (RoleInterface|string)[] $roles An array of roles + * @param (Role|string)[] $roles An array of roles * * @throws \InvalidArgumentException */ @@ -41,7 +41,7 @@ abstract class AbstractToken implements TokenInterface if (\is_string($role)) { $role = new Role($role); } 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; diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php index 7677b90d27..2cbb788490 100644 --- a/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php +++ b/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php @@ -12,6 +12,7 @@ namespace Symfony\Component\Security\Core\Authentication\Token; use Symfony\Component\Security\Core\Role\Role; +use Symfony\Component\Security\Core\User\UserInterface; /** * AnonymousToken represents an anonymous token. @@ -23,9 +24,9 @@ class AnonymousToken extends AbstractToken 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|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string - * @param Role[] $roles An array of roles + * @param string $secret A secret used to make sure the token is created by the app and not by a malicious client + * @param string|\Stringable|UserInterface $user + * @param (Role|string)[] $roles */ public function __construct($secret, $user, array $roles = []) { diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php index 7ff0cfe8a5..31a7b666cc 100644 --- a/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php +++ b/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php @@ -11,7 +11,8 @@ 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. @@ -24,10 +25,10 @@ class PreAuthenticatedToken extends AbstractToken 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 mixed $credentials The user credentials - * @param string $providerKey The provider key - * @param (RoleInterface|string)[] $roles An array of roles + * @param string|\Stringable|UserInterface $user + * @param mixed $credentials + * @param string $providerKey + * @param (Role|string)[] $roles */ public function __construct($user, $credentials, $providerKey, array $roles = []) { diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php index 583700c178..ff30ef9078 100644 --- a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php +++ b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php @@ -12,6 +12,7 @@ namespace Symfony\Component\Security\Core\Authentication\Token; use Symfony\Component\Security\Core\Role\RoleInterface; +use Symfony\Component\Security\Core\User\UserInterface; /** * TokenInterface is the interface for the user authentication information. @@ -47,8 +48,7 @@ interface TokenInterface extends \Serializable /** * Returns a user representation. * - * @return string|object Can be a UserInterface instance, an object implementing a __toString method, - * or the username as a regular string + * @return string|\Stringable|UserInterface * * @see AbstractToken::setUser() */ @@ -60,7 +60,7 @@ interface TokenInterface extends \Serializable * 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 + * @param string|\Stringable|UserInterface $user * * @throws \InvalidArgumentException */ diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php index 9b71520a2b..ae69107edd 100644 --- a/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php +++ b/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php @@ -11,7 +11,8 @@ 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. @@ -24,10 +25,10 @@ class UsernamePasswordToken extends AbstractToken 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 mixed $credentials This usually is the password of the user - * @param string $providerKey The provider key - * @param (RoleInterface|string)[] $roles An array of roles + * @param string|\Stringable|UserInterface $user The username (like a nickname, email address, etc.) or a UserInterface instance + * @param mixed $credentials + * @param string $providerKey + * @param (Role|string)[] $roles * * @throws \InvalidArgumentException */