[Security] add return types

Author: nicolas-grekas

Authentication/AuthenticationTrustResolver.php

@@ -29,15 +29,15 @@ public function isAuthenticated(TokenInterface $token = null): bool
     /**
      * {@inheritdoc}
      */
-    public function isRememberMe(TokenInterface $token = null)
+    public function isRememberMe(TokenInterface $token = null): bool
     {
         return $token && $token instanceof RememberMeToken;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isFullFledged(TokenInterface $token = null)
+    public function isFullFledged(TokenInterface $token = null): bool
     {
         return $this->isAuthenticated($token) && !$this->isRememberMe($token);
     }

Authentication/RememberMe/InMemoryTokenProvider.php

@@ -25,7 +25,7 @@ class InMemoryTokenProvider implements TokenProviderInterface
     /**
      * {@inheritdoc}
      */
-    public function loadTokenBySeries(string $series)
+    public function loadTokenBySeries(string $series): PersistentTokenInterface
     {
         if (!isset($this->tokens[$series])) {
             throw new TokenNotFoundException('No token found.');

Authentication/RememberMe/PersistentTokenInterface.php

@@ -21,31 +21,23 @@ interface PersistentTokenInterface
 {
     /**
      * Returns the class of the user.
-     *
-     * @return string
      */
-    public function getClass();
+    public function getClass(): string;
 
     /**
      * Returns the series.
-     *
-     * @return string
      */
-    public function getSeries();
+    public function getSeries(): string;
 
     /**
      * Returns the token value.
-     *
-     * @return string
      */
-    public function getTokenValue();
+    public function getTokenValue(): string;
 
     /**
      * Returns the time the token was last used.
-     *
-     * @return \DateTime
      */
-    public function getLastUsed();
+    public function getLastUsed(): \DateTime;
 
     /**
      * Returns the identifier used to authenticate (e.g. their email address or username).

Authentication/Token/AbstractToken.php

@@ -11,9 +11,6 @@
 
 namespace Symfony\Component\Security\Core\Authentication\Token;
 
-use Symfony\Component\Security\Core\User\EquatableInterface;
-use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
-use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
@@ -56,7 +53,7 @@ public function getUserIdentifier(): string
     /**
      * {@inheritdoc}
      */
-    public function getUser()
+    public function getUser(): ?UserInterface
     {
         return $this->user;
     }
@@ -123,7 +120,7 @@ public function __unserialize(array $data): void
     /**
      * {@inheritdoc}
      */
-    public function getAttributes()
+    public function getAttributes(): array
     {
         return $this->attributes;
     }
@@ -139,15 +136,15 @@ public function setAttributes(array $attributes)
     /**
      * {@inheritdoc}
      */
-    public function hasAttribute(string $name)
+    public function hasAttribute(string $name): bool
     {
         return \array_key_exists($name, $this->attributes);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getAttribute(string $name)
+    public function getAttribute(string $name): mixed
     {
         if (!\array_key_exists($name, $this->attributes)) {
             throw new \InvalidArgumentException(sprintf('This token has no "%s" attribute.', $name));

Authentication/Token/NullToken.php

@@ -28,7 +28,7 @@ public function getRoleNames(): array
         return [];
     }
 
-    public function getUser()
+    public function getUser(): ?UserInterface
     {
         return null;
     }
@@ -47,7 +47,7 @@ public function eraseCredentials()
     {
     }
 
-    public function getAttributes()
+    public function getAttributes(): array
     {
         return [];
     }
@@ -57,12 +57,12 @@ public function setAttributes(array $attributes)
         throw new \BadMethodCallException('Cannot set attributes of NullToken.');
     }
 
-    public function hasAttribute(string $name)
+    public function hasAttribute(string $name): bool
     {
         return false;
     }
 
-    public function getAttribute(string $name)
+    public function getAttribute(string $name): mixed
     {
         return null;
     }

Authentication/Token/RememberMeToken.php

@@ -51,10 +51,7 @@ public function getFirewallName(): string
         return $this->firewallName;
     }
 
-    /**
-     * @return string
-     */
-    public function getSecret()
+    public function getSecret(): string
     {
         return $this->secret;
     }

Authentication/Token/Storage/TokenStorage.php

@@ -30,7 +30,7 @@ class TokenStorage implements TokenStorageInterface, ResetInterface
     /**
      * {@inheritdoc}
      */
-    public function getToken()
+    public function getToken(): ?TokenInterface
     {
         if ($initializer = $this->initializer) {
             $this->initializer = null;

Authentication/Token/Storage/TokenStorageInterface.php

@@ -22,10 +22,8 @@ interface TokenStorageInterface
 {
     /**
      * Returns the current security token.
-     *
-     * @return TokenInterface|null
      */
-    public function getToken();
+    public function getToken(): ?TokenInterface;
 
     /**
      * Sets the authentication token.

Authentication/Token/TokenInterface.php

@@ -40,11 +40,9 @@ public function getRoleNames(): array;
     /**
      * Returns a user representation.
      *
-     * @return UserInterface|null
-     *
      * @see AbstractToken::setUser()
      */
-    public function getUser();
+    public function getUser(): ?UserInterface;
 
     /**
      * Sets the authenticated user in the token.
@@ -58,27 +56,19 @@ public function setUser(UserInterface $user);
      */
     public function eraseCredentials();
 
-    /**
-     * @return array
-     */
-    public function getAttributes();
+    public function getAttributes(): array;
 
     /**
      * @param array $attributes The token attributes
      */
     public function setAttributes(array $attributes);
 
-    /**
-     * @return bool
-     */
-    public function hasAttribute(string $name);
+    public function hasAttribute(string $name): bool;
 
     /**
-     * @return mixed
-     *
      * @throws \InvalidArgumentException When attribute doesn't exist for this token
      */
-    public function getAttribute(string $name);
+    public function getAttribute(string $name): mixed;
 
     public function setAttribute(string $name, mixed $value);
 

AuthenticationEvents.php

@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Security\Core;
 
-use Symfony\Component\Security\Core\Event\AuthenticationFailureEvent;
 use Symfony\Component\Security\Core\Event\AuthenticationSuccessEvent;
 
 final class AuthenticationEvents