minor #32353 [Security] Added type-hints to user providers (derrabus)

fabpot · fabpot · commit b163a95bd5c9 · 2019-07-04T09:53:37.000+02:00
This PR was merged into the 5.0-dev branch. Discussion ---------- [Security] Added type-hints to user providers | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32179 | License | MIT | Doc PR | N/A This PR adds type declarations to user provider classes. Commits ------- 62abb70 [Security] Added type-hints to user providers.
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php
@@ -44,7 +44,7 @@ public function __construct(ManagerRegistry $registry, string $classOrAlias, str
     /**
      * {@inheritdoc}
      */
-    public function loadUserByUsername($username)
+    public function loadUserByUsername(string $username)
     {
         $repository = $this->getRepository();
         if (null !== $this->property) {
@@ -102,7 +102,7 @@ public function refreshUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function supportsClass($class)
+    public function supportsClass(string $class)
     {
         return $class === $this->getClass() || is_subclass_of($class, $this->getClass());
     }
diff --git a/src/Symfony/Bridge/Doctrine/composer.json b/src/Symfony/Bridge/Doctrine/composer.json
@@ -33,7 +33,7 @@
         "symfony/property-access": "^4.4|^5.0",
         "symfony/property-info": "^4.4|^5.0",
         "symfony/proxy-manager-bridge": "^4.4|^5.0",
-        "symfony/security-core": "^4.4|^5.0",
+        "symfony/security-core": "^5.0",
         "symfony/expression-language": "^4.4|^5.0",
         "symfony/validator": "^4.4|^5.0",
         "symfony/translation": "^4.4|^5.0",
@@ -49,7 +49,8 @@
         "phpunit/phpunit": "<5.4.3",
         "symfony/dependency-injection": "<4.4",
         "symfony/form": "<4.4",
-        "symfony/messenger": "<4.4"
+        "symfony/messenger": "<4.4",
+        "symfony/security-core": "<5"
     },
     "suggest": {
         "symfony/form": "",
diff --git a/src/Symfony/Component/Security/Core/User/ChainUserProvider.php b/src/Symfony/Component/Security/Core/User/ChainUserProvider.php
@@ -49,7 +49,7 @@ public function getProviders()
     /**
      * {@inheritdoc}
      */
-    public function loadUserByUsername($username)
+    public function loadUserByUsername(string $username)
     {
         foreach ($this->providers as $provider) {
             try {
@@ -94,7 +94,7 @@ public function refreshUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function supportsClass($class)
+    public function supportsClass(string $class)
     {
         foreach ($this->providers as $provider) {
             if ($provider->supportsClass($class)) {
diff --git a/src/Symfony/Component/Security/Core/User/InMemoryUserProvider.php b/src/Symfony/Component/Security/Core/User/InMemoryUserProvider.php
@@ -61,7 +61,7 @@ public function createUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function loadUserByUsername($username)
+    public function loadUserByUsername(string $username)
     {
         $user = $this->getUser($username);
 
@@ -85,7 +85,7 @@ public function refreshUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function supportsClass($class)
+    public function supportsClass(string $class)
     {
         return 'Symfony\Component\Security\Core\User\User' === $class;
     }
@@ -99,7 +99,7 @@ public function supportsClass($class)
      *
      * @throws UsernameNotFoundException if user whose given username does not exist
      */
-    private function getUser($username)
+    private function getUser(string $username)
     {
         if (!isset($this->users[strtolower($username)])) {
             $ex = new UsernameNotFoundException(sprintf('Username "%s" does not exist.', $username));
diff --git a/src/Symfony/Component/Security/Core/User/LdapUserProvider.php b/src/Symfony/Component/Security/Core/User/LdapUserProvider.php
@@ -60,7 +60,7 @@ public function __construct(LdapInterface $ldap, string $baseDn, string $searchD
     /**
      * {@inheritdoc}
      */
-    public function loadUserByUsername($username)
+    public function loadUserByUsername(string $username)
     {
         try {
             $this->ldap->bind($this->searchDn, $this->searchPassword);
@@ -109,20 +109,17 @@ public function refreshUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function supportsClass($class)
+    public function supportsClass(string $class)
     {
         return 'Symfony\Component\Security\Core\User\User' === $class;
     }
 
     /**
      * Loads a user from an LDAP entry.
      *
-     * @param string $username
-     * @param Entry  $entry
-     *
      * @return User
      */
-    protected function loadUser($username, Entry $entry)
+    protected function loadUser(string $username, Entry $entry)
     {
         $password = null;
         $extraFields = [];
@@ -140,11 +137,8 @@ protected function loadUser($username, Entry $entry)
 
     /**
      * Fetches a required unique attribute value from an LDAP entry.
-     *
-     * @param Entry|null $entry
-     * @param string     $attribute
      */
-    private function getAttributeValue(Entry $entry, $attribute)
+    private function getAttributeValue(Entry $entry, string $attribute)
     {
         if (!$entry->hasAttribute($attribute)) {
             throw new InvalidArgumentException(sprintf('Missing attribute "%s" for user "%s".', $attribute, $entry->getDn()));
diff --git a/src/Symfony/Component/Security/Core/User/MissingUserProvider.php b/src/Symfony/Component/Security/Core/User/MissingUserProvider.php
@@ -32,7 +32,7 @@ public function __construct(string $firewall)
     /**
      * {@inheritdoc}
      */
-    public function loadUserByUsername($username)
+    public function loadUserByUsername(string $username)
     {
         throw new \BadMethodCallException();
     }
@@ -48,7 +48,7 @@ public function refreshUser(UserInterface $user)
     /**
      * {@inheritdoc}
      */
-    public function supportsClass($class)
+    public function supportsClass(string $class)
     {
         throw new \BadMethodCallException();
     }
diff --git a/src/Symfony/Component/Security/Core/User/UserProviderInterface.php b/src/Symfony/Component/Security/Core/User/UserProviderInterface.php
@@ -39,13 +39,11 @@ interface UserProviderInterface
      * This method must throw UsernameNotFoundException if the user is not
      * found.
      *
-     * @param string $username The username
-     *
      * @return UserInterface
      *
      * @throws UsernameNotFoundException if the user is not found
      */
-    public function loadUserByUsername($username);
+    public function loadUserByUsername(string $username);
 
     /**
      * Refreshes the user.
@@ -65,9 +63,7 @@ public function refreshUser(UserInterface $user);
     /**
      * Whether this provider supports the given user class.
      *
-     * @param string $class
-     *
      * @return bool
      */
-    public function supportsClass($class);
+    public function supportsClass(string $class);
 }

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function __construct(ManagerRegistry $registry, string $classOrAlias, str`
`44`	`44`	`/**`
`45`	`45`	`* {@inheritdoc}`
`46`	`46`	`*/`
`47`		`- public function loadUserByUsername($username)`
	`47`	`+ public function loadUserByUsername(string $username)`
`48`	`48`	`{`
`49`	`49`	`$repository = $this->getRepository();`
`50`	`50`	`if (null !== $this->property) {`
`@@ -102,7 +102,7 @@ public function refreshUser(UserInterface $user)`
`102`	`102`	`/**`
`103`	`103`	`* {@inheritdoc}`
`104`	`104`	`*/`
`105`		`- public function supportsClass($class)`
	`105`	`+ public function supportsClass(string $class)`
`106`	`106`	`{`
`107`	`107`	`return $class === $this->getClass() \|\| is_subclass_of($class, $this->getClass());`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function createUser(UserInterface $user)`
`61`	`61`	`/**`
`62`	`62`	`* {@inheritdoc}`
`63`	`63`	`*/`
`64`		`- public function loadUserByUsername($username)`
	`64`	`+ public function loadUserByUsername(string $username)`
`65`	`65`	`{`
`66`	`66`	`$user = $this->getUser($username);`
`67`	`67`
`@@ -85,7 +85,7 @@ public function refreshUser(UserInterface $user)`
`85`	`85`	`/**`
`86`	`86`	`* {@inheritdoc}`
`87`	`87`	`*/`
`88`		`- public function supportsClass($class)`
	`88`	`+ public function supportsClass(string $class)`
`89`	`89`	`{`
`90`	`90`	`return 'Symfony\Component\Security\Core\User\User' === $class;`
`91`	`91`	`}`
`@@ -99,7 +99,7 @@ public function supportsClass($class)`
`99`	`99`	`*`
`100`	`100`	`* @throws UsernameNotFoundException if user whose given username does not exist`
`101`	`101`	`*/`
`102`		`- private function getUser($username)`
	`102`	`+ private function getUser(string $username)`
`103`	`103`	`{`
`104`	`104`	`if (!isset($this->users[strtolower($username)])) {`
`105`	`105`	`$ex = new UsernameNotFoundException(sprintf('Username "%s" does not exist.', $username));`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function __construct(string $firewall)`
`32`	`32`	`/**`
`33`	`33`	`* {@inheritdoc}`
`34`	`34`	`*/`
`35`		`- public function loadUserByUsername($username)`
	`35`	`+ public function loadUserByUsername(string $username)`
`36`	`36`	`{`
`37`	`37`	`throw new \BadMethodCallException();`
`38`	`38`	`}`
`@@ -48,7 +48,7 @@ public function refreshUser(UserInterface $user)`
`48`	`48`	`/**`
`49`	`49`	`* {@inheritdoc}`
`50`	`50`	`*/`
`51`		`- public function supportsClass($class)`
	`51`	`+ public function supportsClass(string $class)`
`52`	`52`	`{`
`53`	`53`	`throw new \BadMethodCallException();`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,13 +39,11 @@ interface UserProviderInterface`
`39`	`39`	`* This method must throw UsernameNotFoundException if the user is not`
`40`	`40`	`* found.`
`41`	`41`	`*`
`42`		`- * @param string $username The username`
`43`		`- *`
`44`	`42`	`* @return UserInterface`
`45`	`43`	`*`
`46`	`44`	`* @throws UsernameNotFoundException if the user is not found`
`47`	`45`	`*/`
`48`		`- public function loadUserByUsername($username);`
	`46`	`+ public function loadUserByUsername(string $username);`
`49`	`47`
`50`	`48`	`/**`
`51`	`49`	`* Refreshes the user.`
`@@ -65,9 +63,7 @@ public function refreshUser(UserInterface $user);`
`65`	`63`	`/**`
`66`	`64`	`* Whether this provider supports the given user class.`
`67`	`65`	`*`
`68`		`- * @param string $class`
`69`		`- *`
`70`	`66`	`* @return bool`
`71`	`67`	`*/`
`72`		`- public function supportsClass($class);`
	`68`	`+ public function supportsClass(string $class);`
`73`	`69`	`}`