Replace more docblocks by type-hints

Author: nicolas-grekas

Authentication/AuthenticationProviderManager.php

@@ -40,14 +40,14 @@ class AuthenticationProviderManager implements AuthenticationManagerInterface
      *
      * @throws \InvalidArgumentException
      */
-    public function __construct($providers, $eraseCredentials = true)
+    public function __construct(iterable $providers, bool $eraseCredentials = true)
     {
         if (!$providers) {
             throw new \InvalidArgumentException('You must at least add one authentication provider.');
         }
 
         $this->providers = $providers;
-        $this->eraseCredentials = (bool) $eraseCredentials;
+        $this->eraseCredentials = $eraseCredentials;
     }
 
     public function setEventDispatcher(EventDispatcherInterface $dispatcher)

Authentication/AuthenticationTrustResolver.php

@@ -23,11 +23,7 @@ class AuthenticationTrustResolver implements AuthenticationTrustResolverInterfac
     private $anonymousClass;
     private $rememberMeClass;
 
-    /**
-     * @param string $anonymousClass
-     * @param string $rememberMeClass
-     */
-    public function __construct($anonymousClass, $rememberMeClass)
+    public function __construct(string $anonymousClass, string $rememberMeClass)
     {
         $this->anonymousClass = $anonymousClass;
         $this->rememberMeClass = $rememberMeClass;

Authentication/Provider/AnonymousAuthenticationProvider.php

@@ -34,7 +34,7 @@ class AnonymousAuthenticationProvider implements AuthenticationProviderInterface
     /**
      * @param string $secret The secret shared with the AnonymousToken
      */
-    public function __construct($secret)
+    public function __construct(string $secret)
     {
         $this->secret = $secret;
     }

Authentication/Provider/DaoAuthenticationProvider.php

@@ -31,14 +31,7 @@ class DaoAuthenticationProvider extends UserAuthenticationProvider
     private $encoderFactory;
     private $userProvider;
 
-    /**
-     * @param UserProviderInterface   $userProvider               An UserProviderInterface instance
-     * @param UserCheckerInterface    $userChecker                An UserCheckerInterface instance
-     * @param string                  $providerKey                The provider key
-     * @param EncoderFactoryInterface $encoderFactory             An EncoderFactoryInterface instance
-     * @param bool                    $hideUserNotFoundExceptions Whether to hide user not found exception or not
-     */
-    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, $providerKey, EncoderFactoryInterface $encoderFactory, $hideUserNotFoundExceptions = true)
+    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, string $providerKey, EncoderFactoryInterface $encoderFactory, bool $hideUserNotFoundExceptions = true)
     {
         parent::__construct($userChecker, $providerKey, $hideUserNotFoundExceptions);
 

Authentication/Provider/LdapBindAuthenticationProvider.php

@@ -35,15 +35,7 @@ class LdapBindAuthenticationProvider extends UserAuthenticationProvider
     private $dnString;
     private $queryString;
 
-    /**
-     * @param UserProviderInterface $userProvider               A UserProvider
-     * @param UserCheckerInterface  $userChecker                A UserChecker
-     * @param string                $providerKey                The provider key
-     * @param LdapInterface         $ldap                       A Ldap client
-     * @param string                $dnString                   A string used to create the bind DN
-     * @param bool                  $hideUserNotFoundExceptions Whether to hide user not found exception or not
-     */
-    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, $providerKey, LdapInterface $ldap, $dnString = '{username}', $hideUserNotFoundExceptions = true)
+    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, string $providerKey, LdapInterface $ldap, string $dnString = '{username}', bool $hideUserNotFoundExceptions = true)
     {
         parent::__construct($userChecker, $providerKey, $hideUserNotFoundExceptions);
 

Authentication/Provider/PreAuthenticatedAuthenticationProvider.php

@@ -34,7 +34,7 @@ class PreAuthenticatedAuthenticationProvider implements AuthenticationProviderIn
     private $userChecker;
     private $providerKey;
 
-    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, $providerKey)
+    public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, string $providerKey)
     {
         $this->userProvider = $userProvider;
         $this->userChecker = $userChecker;

Authentication/Provider/RememberMeAuthenticationProvider.php

@@ -28,7 +28,7 @@ class RememberMeAuthenticationProvider implements AuthenticationProviderInterfac
      * @param string               $secret      A secret
      * @param string               $providerKey A provider secret
      */
-    public function __construct(UserCheckerInterface $userChecker, $secret, $providerKey)
+    public function __construct(UserCheckerInterface $userChecker, string $secret, string $providerKey)
     {
         $this->userChecker = $userChecker;
         $this->secret = $secret;

Authentication/Provider/SimpleAuthenticationProvider.php

@@ -25,7 +25,7 @@ class SimpleAuthenticationProvider implements AuthenticationProviderInterface
     private $userProvider;
     private $providerKey;
 
-    public function __construct(SimpleAuthenticatorInterface $simpleAuthenticator, UserProviderInterface $userProvider, $providerKey)
+    public function __construct(SimpleAuthenticatorInterface $simpleAuthenticator, UserProviderInterface $userProvider, string $providerKey)
     {
         $this->simpleAuthenticator = $simpleAuthenticator;
         $this->userProvider = $userProvider;

Authentication/Provider/UserAuthenticationProvider.php

@@ -33,13 +33,9 @@ abstract class UserAuthenticationProvider implements AuthenticationProviderInter
     private $providerKey;
 
     /**
-     * @param UserCheckerInterface $userChecker                An UserCheckerInterface interface
-     * @param string               $providerKey                A provider key
-     * @param bool                 $hideUserNotFoundExceptions Whether to hide user not found exception or not
-     *
      * @throws \InvalidArgumentException
      */
-    public function __construct(UserCheckerInterface $userChecker, $providerKey, $hideUserNotFoundExceptions = true)
+    public function __construct(UserCheckerInterface $userChecker, string $providerKey, bool $hideUserNotFoundExceptions = true)
     {
         if (empty($providerKey)) {
             throw new \InvalidArgumentException('$providerKey must not be empty.');

Authentication/Token/AnonymousToken.php

@@ -27,7 +27,7 @@ class AnonymousToken extends AbstractToken
      * @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
      */
-    public function __construct($secret, $user, array $roles = array())
+    public function __construct(string $secret, $user, array $roles = array())
     {
         parent::__construct($roles);
 

Authentication/Token/PreAuthenticatedToken.php

@@ -27,7 +27,7 @@ class PreAuthenticatedToken extends AbstractToken
      * @param string          $providerKey The provider key
      * @param (Role|string)[] $roles       An array of roles
      */
-    public function __construct($user, $credentials, $providerKey, array $roles = array())
+    public function __construct($user, $credentials, string $providerKey, array $roles = array())
     {
         parent::__construct($roles);
 

Authentication/Token/RememberMeToken.php

@@ -30,7 +30,7 @@ class RememberMeToken extends AbstractToken
      *
      * @throws \InvalidArgumentException
      */
-    public function __construct(UserInterface $user, $providerKey, $secret)
+    public function __construct(UserInterface $user, string $providerKey, string $secret)
     {
         parent::__construct($user->getRoles());
 

Authentication/Token/UsernamePasswordToken.php

@@ -29,7 +29,7 @@ class UsernamePasswordToken extends AbstractToken
      *
      * @throws \InvalidArgumentException
      */
-    public function __construct($user, $credentials, $providerKey, array $roles = array())
+    public function __construct($user, $credentials, string $providerKey, array $roles = array())
     {
         parent::__construct($roles);
 

Authorization/AccessDecisionManager.php

@@ -39,7 +39,7 @@ class AccessDecisionManager implements AccessDecisionManagerInterface
      *
      * @throws \InvalidArgumentException
      */
-    public function __construct($voters = array(), $strategy = self::STRATEGY_AFFIRMATIVE, $allowIfAllAbstainDecisions = false, $allowIfEqualGrantedDeniedDecisions = true)
+    public function __construct(iterable $voters = array(), string $strategy = self::STRATEGY_AFFIRMATIVE, bool $allowIfAllAbstainDecisions = false, bool $allowIfEqualGrantedDeniedDecisions = true)
     {
         $strategyMethod = 'decide'.ucfirst($strategy);
         if (!is_callable(array($this, $strategyMethod))) {
@@ -48,8 +48,8 @@ public function __construct($voters = array(), $strategy = self::STRATEGY_AFFIRM
 
         $this->voters = $voters;
         $this->strategy = $strategyMethod;
-        $this->allowIfAllAbstainDecisions = (bool) $allowIfAllAbstainDecisions;
-        $this->allowIfEqualGrantedDeniedDecisions = (bool) $allowIfEqualGrantedDeniedDecisions;
+        $this->allowIfAllAbstainDecisions = $allowIfAllAbstainDecisions;
+        $this->allowIfEqualGrantedDeniedDecisions = $allowIfEqualGrantedDeniedDecisions;
     }
 
     /**

Authorization/AuthorizationChecker.php

@@ -30,13 +30,7 @@ class AuthorizationChecker implements AuthorizationCheckerInterface
     private $authenticationManager;
     private $alwaysAuthenticate;
 
-    /**
-     * @param TokenStorageInterface          $tokenStorage
-     * @param AuthenticationManagerInterface $authenticationManager An AuthenticationManager instance
-     * @param AccessDecisionManagerInterface $accessDecisionManager An AccessDecisionManager instance
-     * @param bool                           $alwaysAuthenticate
-     */
-    public function __construct(TokenStorageInterface $tokenStorage, AuthenticationManagerInterface $authenticationManager, AccessDecisionManagerInterface $accessDecisionManager, $alwaysAuthenticate = false)
+    public function __construct(TokenStorageInterface $tokenStorage, AuthenticationManagerInterface $authenticationManager, AccessDecisionManagerInterface $accessDecisionManager, bool $alwaysAuthenticate = false)
     {
         $this->tokenStorage = $tokenStorage;
         $this->authenticationManager = $authenticationManager;

Authorization/Voter/RoleHierarchyVoter.php

@@ -24,7 +24,7 @@ class RoleHierarchyVoter extends RoleVoter
 {
     private $roleHierarchy;
 
-    public function __construct(RoleHierarchyInterface $roleHierarchy, $prefix = 'ROLE_')
+    public function __construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_')
     {
         $this->roleHierarchy = $roleHierarchy;
 

Authorization/Voter/RoleVoter.php

@@ -23,10 +23,7 @@ class RoleVoter implements VoterInterface
 {
     private $prefix;
 
-    /**
-     * @param string $prefix The role prefix
-     */
-    public function __construct($prefix = 'ROLE_')
+    public function __construct(string $prefix = 'ROLE_')
     {
         $this->prefix = $prefix;
     }

Encoder/BCryptPasswordEncoder.php

@@ -29,9 +29,8 @@ class BCryptPasswordEncoder extends BasePasswordEncoder implements SelfSaltingEn
      * @throws \RuntimeException         When no BCrypt encoder is available
      * @throws \InvalidArgumentException if cost is out of range
      */
-    public function __construct($cost)
+    public function __construct(int $cost)
     {
-        $cost = (int) $cost;
         if ($cost < 4 || $cost > 31) {
             throw new \InvalidArgumentException('Cost must be in the range of 4-31.');
         }

Encoder/MessageDigestPasswordEncoder.php

@@ -29,7 +29,7 @@ class MessageDigestPasswordEncoder extends BasePasswordEncoder
      * @param bool   $encodeHashAsBase64 Whether to base64 encode the password hash
      * @param int    $iterations         The number of iterations to use to stretch the password hash
      */
-    public function __construct($algorithm = 'sha512', $encodeHashAsBase64 = true, $iterations = 5000)
+    public function __construct(string $algorithm = 'sha512', bool $encodeHashAsBase64 = true, int $iterations = 5000)
     {
         $this->algorithm = $algorithm;
         $this->encodeHashAsBase64 = $encodeHashAsBase64;

Encoder/Pbkdf2PasswordEncoder.php

@@ -39,7 +39,7 @@ class Pbkdf2PasswordEncoder extends BasePasswordEncoder
      * @param int    $iterations         The number of iterations to use to stretch the password hash
      * @param int    $length             Length of derived key to create
      */
-    public function __construct($algorithm = 'sha512', $encodeHashAsBase64 = true, $iterations = 1000, $length = 40)
+    public function __construct(string $algorithm = 'sha512', bool $encodeHashAsBase64 = true, int $iterations = 1000, int $length = 40)
     {
         $this->algorithm = $algorithm;
         $this->encodeHashAsBase64 = $encodeHashAsBase64;

Encoder/PlaintextPasswordEncoder.php

@@ -25,7 +25,7 @@ class PlaintextPasswordEncoder extends BasePasswordEncoder
     /**
      * @param bool $ignorePasswordCase Compare password case-insensitive
      */
-    public function __construct($ignorePasswordCase = false)
+    public function __construct(bool $ignorePasswordCase = false)
     {
         $this->ignorePasswordCase = $ignorePasswordCase;
     }

Exception/AccessDeniedException.php

@@ -21,7 +21,7 @@ class AccessDeniedException extends \RuntimeException
     private $attributes = array();
     private $subject;
 
-    public function __construct($message = 'Access Denied.', \Exception $previous = null)
+    public function __construct(string $message = 'Access Denied.', \Exception $previous = null)
     {
         parent::__construct($message, 403, $previous);
     }

Exception/CustomUserMessageAuthenticationException.php

@@ -26,7 +26,7 @@ class CustomUserMessageAuthenticationException extends AuthenticationException
 
     private $messageData = array();
 
-    public function __construct($message = '', array $messageData = array(), $code = 0, \Exception $previous = null)
+    public function __construct(string $message = '', array $messageData = array(), int $code = 0, \Exception $previous = null)
     {
         parent::__construct($message, $code, $previous);
 

Exception/LogoutException.php

@@ -18,7 +18,7 @@
  */
 class LogoutException extends \RuntimeException
 {
-    public function __construct($message = 'Logout Exception', \Exception $previous = null)
+    public function __construct(string $message = 'Logout Exception', \Exception $previous = null)
     {
         parent::__construct($message, 403, $previous);
     }

Role/Role.php

@@ -20,12 +20,9 @@ class Role
 {
     private $role;
 
-    /**
-     * @param string $role The role name
-     */
-    public function __construct($role)
+    public function __construct(string $role)
     {
-        $this->role = (string) $role;
+        $this->role = $role;
     }
 
     /**

Role/SwitchUserRole.php

@@ -27,7 +27,7 @@ class SwitchUserRole extends Role
      * @param string         $role   The role as a string
      * @param TokenInterface $source The original token
      */
-    public function __construct($role, TokenInterface $source)
+    public function __construct(string $role, TokenInterface $source)
     {
         parent::__construct($role);
 

Tests/Authentication/Token/RememberMeTokenTest.php

@@ -30,7 +30,7 @@ public function testConstructor()
     }
 
     /**
-     * @expectedException \InvalidArgumentException
+     * @expectedException \TypeError
      */
     public function testConstructorSecretCannotBeNull()
     {
@@ -57,7 +57,7 @@ protected function getUser($roles = array('ROLE_FOO'))
     {
         $user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
         $user
-            ->expects($this->once())
+            ->expects($this->any())
             ->method('getRoles')
             ->will($this->returnValue($roles))
         ;

User/LdapUserProvider.php

@@ -35,17 +35,7 @@ class LdapUserProvider implements UserProviderInterface
     private $defaultSearch;
     private $passwordAttribute;
 
-    /**
-     * @param LdapInterface $ldap
-     * @param string        $baseDn
-     * @param string        $searchDn
-     * @param string        $searchPassword
-     * @param array         $defaultRoles
-     * @param string        $uidKey
-     * @param string        $filter
-     * @param string        $passwordAttribute
-     */
-    public function __construct(LdapInterface $ldap, $baseDn, $searchDn = null, $searchPassword = null, array $defaultRoles = array(), $uidKey = 'sAMAccountName', $filter = '({uid_key}={username})', $passwordAttribute = null)
+    public function __construct(LdapInterface $ldap, string $baseDn, string $searchDn = null, string $searchPassword = null, array $defaultRoles = array(), string $uidKey = 'sAMAccountName', string $filter = '({uid_key}={username})', string $passwordAttribute = null)
     {
         if (null === $uidKey) {
             $uidKey = 'sAMAccountName';

User/User.php

@@ -28,7 +28,7 @@ final class User implements AdvancedUserInterface
     private $accountNonLocked;
     private $roles;
 
-    public function __construct($username, $password, array $roles = array(), $enabled = true, $userNonExpired = true, $credentialsNonExpired = true, $userNonLocked = true)
+    public function __construct(?string $username, ?string $password, array $roles = array(), bool $enabled = true, bool $userNonExpired = true, bool $credentialsNonExpired = true, bool $userNonLocked = true)
     {
         if ('' === $username || null === $username) {
             throw new \InvalidArgumentException('The username cannot be empty.');