[Components] Convert to native return types

wouterj · nicolas-grekas · commit e267f60fb554 · 2023-07-05T15:06:06.000+02:00
diff --git a/Authentication/RememberMe/InMemoryTokenProvider.php b/Authentication/RememberMe/InMemoryTokenProvider.php
@@ -31,10 +31,7 @@ public function loadTokenBySeries(string $series): PersistentTokenInterface
         return $this->tokens[$series];
     }
 
-    /**
-     * @return void
-     */
-    public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed)
+    public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed): void
     {
         if (!isset($this->tokens[$series])) {
             throw new TokenNotFoundException('No token found.');
@@ -50,18 +47,12 @@ public function updateToken(string $series, #[\SensitiveParameter] string $token
         $this->tokens[$series] = $token;
     }
 
-    /**
-     * @return void
-     */
-    public function deleteTokenBySeries(string $series)
+    public function deleteTokenBySeries(string $series): void
     {
         unset($this->tokens[$series]);
     }
 
-    /**
-     * @return void
-     */
-    public function createNewToken(PersistentTokenInterface $token)
+    public function createNewToken(PersistentTokenInterface $token): void
     {
         $this->tokens[$token->getSeries()] = $token;
     }
diff --git a/Authentication/RememberMe/TokenProviderInterface.php b/Authentication/RememberMe/TokenProviderInterface.php
@@ -23,32 +23,24 @@ interface TokenProviderInterface
     /**
      * Loads the active token for the given series.
      *
-     * @return PersistentTokenInterface
-     *
      * @throws TokenNotFoundException if the token is not found
      */
-    public function loadTokenBySeries(string $series);
+    public function loadTokenBySeries(string $series): PersistentTokenInterface;
 
     /**
      * Deletes all tokens belonging to series.
-     *
-     * @return void
      */
-    public function deleteTokenBySeries(string $series);
+    public function deleteTokenBySeries(string $series): void;
 
     /**
      * Updates the token according to this data.
      *
-     * @return void
-     *
      * @throws TokenNotFoundException if the token is not found
      */
-    public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed);
+    public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed): void;
 
     /**
      * Creates a new token.
-     *
-     * @return void
      */
-    public function createNewToken(PersistentTokenInterface $token);
+    public function createNewToken(PersistentTokenInterface $token): void;
 }
diff --git a/Authentication/Token/AbstractToken.php b/Authentication/Token/AbstractToken.php
@@ -53,18 +53,12 @@ public function getUser(): ?UserInterface
         return $this->user;
     }
 
-    /**
-     * @return void
-     */
-    public function setUser(UserInterface $user)
+    public function setUser(UserInterface $user): void
     {
         $this->user = $user;
     }
 
-    /**
-     * @return void
-     */
-    public function eraseCredentials()
+    public function eraseCredentials(): void
     {
         if ($this->getUser() instanceof UserInterface) {
             $this->getUser()->eraseCredentials();
@@ -118,10 +112,7 @@ public function getAttributes(): array
         return $this->attributes;
     }
 
-    /**
-     * @return void
-     */
-    public function setAttributes(array $attributes)
+    public function setAttributes(array $attributes): void
     {
         $this->attributes = $attributes;
     }
@@ -140,10 +131,7 @@ public function getAttribute(string $name): mixed
         return $this->attributes[$name];
     }
 
-    /**
-     * @return void
-     */
-    public function setAttribute(string $name, mixed $value)
+    public function setAttribute(string $name, mixed $value): void
     {
         $this->attributes[$name] = $value;
     }
diff --git a/Authentication/Token/NullToken.php b/Authentication/Token/NullToken.php
@@ -33,10 +33,7 @@ public function getUser(): ?UserInterface
         return null;
     }
 
-    /**
-     * @return never
-     */
-    public function setUser(UserInterface $user)
+    public function setUser(UserInterface $user): never
     {
         throw new \BadMethodCallException('Cannot set user on a NullToken.');
     }
@@ -46,10 +43,7 @@ public function getUserIdentifier(): string
         return '';
     }
 
-    /**
-     * @return void
-     */
-    public function eraseCredentials()
+    public function eraseCredentials(): void
     {
     }
 
@@ -58,10 +52,7 @@ public function getAttributes(): array
         return [];
     }
 
-    /**
-     * @return never
-     */
-    public function setAttributes(array $attributes)
+    public function setAttributes(array $attributes): never
     {
         throw new \BadMethodCallException('Cannot set attributes of NullToken.');
     }
@@ -76,10 +67,7 @@ public function getAttribute(string $name): mixed
         return null;
     }
 
-    /**
-     * @return never
-     */
-    public function setAttribute(string $name, mixed $value)
+    public function setAttribute(string $name, mixed $value): never
     {
         throw new \BadMethodCallException('Cannot add attribute to NullToken.');
     }
diff --git a/Authentication/Token/Storage/TokenStorage.php b/Authentication/Token/Storage/TokenStorage.php
@@ -37,10 +37,7 @@ public function getToken(): ?TokenInterface
         return $this->token;
     }
 
-    /**
-     * @return void
-     */
-    public function setToken(?TokenInterface $token)
+    public function setToken(?TokenInterface $token): void
     {
         if ($token) {
             // ensure any initializer is called
@@ -56,10 +53,7 @@ public function setInitializer(?callable $initializer): void
         $this->initializer = null === $initializer ? null : $initializer(...);
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
         $this->setToken(null);
     }
diff --git a/Authentication/Token/Storage/TokenStorageInterface.php b/Authentication/Token/Storage/TokenStorageInterface.php
@@ -29,8 +29,6 @@ public function getToken(): ?TokenInterface;
      * Sets the authentication token.
      *
      * @param TokenInterface|null $token A TokenInterface token, or null if no further authentication information should be stored
-     *
-     * @return void
      */
-    public function setToken(?TokenInterface $token);
+    public function setToken(?TokenInterface $token): void;
 }
diff --git a/Authentication/Token/TokenInterface.php b/Authentication/Token/TokenInterface.php
@@ -50,27 +50,21 @@ public function getUser(): ?UserInterface;
     /**
      * Sets the authenticated user in the token.
      *
-     * @return void
-     *
      * @throws \InvalidArgumentException
      */
-    public function setUser(UserInterface $user);
+    public function setUser(UserInterface $user): void;
 
     /**
      * Removes sensitive information from the token.
-     *
-     * @return void
      */
-    public function eraseCredentials();
+    public function eraseCredentials(): void;
 
     public function getAttributes(): array;
 
     /**
      * @param array $attributes The token attributes
-     *
-     * @return void
      */
-    public function setAttributes(array $attributes);
+    public function setAttributes(array $attributes): void;
 
     public function hasAttribute(string $name): bool;
 
@@ -79,10 +73,7 @@ public function hasAttribute(string $name): bool;
      */
     public function getAttribute(string $name): mixed;
 
-    /**
-     * @return void
-     */
-    public function setAttribute(string $name, mixed $value);
+    public function setAttribute(string $name, mixed $value): void;
 
     /**
      * Returns all the necessary state of the object for serialization purposes.
diff --git a/Authorization/Voter/RoleHierarchyVoter.php b/Authorization/Voter/RoleHierarchyVoter.php
@@ -31,10 +31,7 @@ public function __construct(RoleHierarchyInterface $roleHierarchy, string $prefi
         parent::__construct($prefix);
     }
 
-    /**
-     * @return array
-     */
-    protected function extractRoles(TokenInterface $token)
+    protected function extractRoles(TokenInterface $token): array
     {
         return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());
     }
diff --git a/Authorization/Voter/RoleVoter.php b/Authorization/Voter/RoleVoter.php
@@ -58,10 +58,7 @@ public function supportsType(string $subjectType): bool
         return true;
     }
 
-    /**
-     * @return array
-     */
-    protected function extractRoles(TokenInterface $token)
+    protected function extractRoles(TokenInterface $token): array
     {
         return $token->getRoleNames();
     }
diff --git a/Event/AuthenticationEvent.php b/Event/AuthenticationEvent.php
@@ -28,10 +28,7 @@ public function __construct(TokenInterface $token)
         $this->authenticationToken = $token;
     }
 
-    /**
-     * @return TokenInterface
-     */
-    public function getAuthenticationToken()
+    public function getAuthenticationToken(): TokenInterface
     {
         return $this->authenticationToken;
     }
diff --git a/Exception/AccessDeniedException.php b/Exception/AccessDeniedException.php
@@ -34,10 +34,7 @@ public function getAttributes(): array
         return $this->attributes;
     }
 
-    /**
-     * @return void
-     */
-    public function setAttributes(array|string $attributes)
+    public function setAttributes(array|string $attributes): void
     {
         $this->attributes = (array) $attributes;
     }
@@ -47,10 +44,7 @@ public function getSubject(): mixed
         return $this->subject;
     }
 
-    /**
-     * @return void
-     */
-    public function setSubject(mixed $subject)
+    public function setSubject(mixed $subject): void
     {
         $this->subject = $subject;
     }
diff --git a/Exception/AccountStatusException.php b/Exception/AccountStatusException.php
@@ -32,10 +32,7 @@ public function getUser(): ?UserInterface
         return $this->user;
     }
 
-    /**
-     * @return void
-     */
-    public function setUser(UserInterface $user)
+    public function setUser(UserInterface $user): void
     {
         $this->user = $user;
     }
diff --git a/Exception/AuthenticationException.php b/Exception/AuthenticationException.php
@@ -39,10 +39,7 @@ public function getToken(): ?TokenInterface
         return $this->token;
     }
 
-    /**
-     * @return void
-     */
-    public function setToken(TokenInterface $token)
+    public function setToken(TokenInterface $token): void
     {
         $this->token = $token;
     }
@@ -90,10 +87,8 @@ public function __unserialize(array $data): void
 
     /**
      * Message key to be used by the translation component.
-     *
-     * @return string
      */
-    public function getMessageKey()
+    public function getMessageKey(): string
     {
         return 'An authentication exception occurred.';
     }
diff --git a/Exception/CustomUserMessageAccountStatusException.php b/Exception/CustomUserMessageAccountStatusException.php
@@ -38,10 +38,8 @@ public function __construct(string $message = '', array $messageData = [], int $
      *
      * @param string $messageKey  The message or message key
      * @param array  $messageData Data to be passed into the translator
-     *
-     * @return void
      */
-    public function setSafeMessage(string $messageKey, array $messageData = [])
+    public function setSafeMessage(string $messageKey, array $messageData = []): void
     {
         $this->messageKey = $messageKey;
         $this->messageData = $messageData;
diff --git a/Exception/CustomUserMessageAuthenticationException.php b/Exception/CustomUserMessageAuthenticationException.php
@@ -37,10 +37,8 @@ public function __construct(string $message = '', array $messageData = [], int $
      *
      * @param string $messageKey  The message or message key
      * @param array  $messageData Data to be passed into the translator
-     *
-     * @return void
      */
-    public function setSafeMessage(string $messageKey, array $messageData = [])
+    public function setSafeMessage(string $messageKey, array $messageData = []): void
     {
         $this->messageKey = $messageKey;
         $this->messageData = $messageData;
diff --git a/Role/RoleHierarchy.php b/Role/RoleHierarchy.php
@@ -49,10 +49,7 @@ public function getReachableRoleNames(array $roles): array
         return array_values(array_unique($reachableRoles));
     }
 
-    /**
-     * @return void
-     */
-    protected function buildRoleMap()
+    protected function buildRoleMap(): void
     {
         $this->map = [];
         foreach ($this->hierarchy as $main => $roles) {
diff --git a/User/InMemoryUserChecker.php b/User/InMemoryUserChecker.php
@@ -20,10 +20,7 @@
  */
 class InMemoryUserChecker implements UserCheckerInterface
 {
-    /**
-     * @return void
-     */
-    public function checkPreAuth(UserInterface $user)
+    public function checkPreAuth(UserInterface $user): void
     {
         if (!$user instanceof InMemoryUser) {
             return;
@@ -36,10 +33,7 @@ public function checkPreAuth(UserInterface $user)
         }
     }
 
-    /**
-     * @return void
-     */
-    public function checkPostAuth(UserInterface $user)
+    public function checkPostAuth(UserInterface $user): void
     {
     }
 }
diff --git a/User/InMemoryUserProvider.php b/User/InMemoryUserProvider.php
diff --git a/User/UserCheckerInterface.php b/User/UserCheckerInterface.php
diff --git a/User/UserInterface.php b/User/UserInterface.php
diff --git a/User/UserProviderInterface.php b/User/UserProviderInterface.php
diff --git a/Validator/Constraints/UserPasswordValidator.php b/Validator/Constraints/UserPasswordValidator.php

Original file line number	Diff line number	Diff line change
`@@ -31,10 +31,7 @@ public function loadTokenBySeries(string $series): PersistentTokenInterface`
`31`	`31`	`return $this->tokens[$series];`
`32`	`32`	`}`
`33`	`33`
`34`		`- /**`
`35`		`- * @return void`
`36`		`- */`
`37`		`- public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed)`
	`34`	`+ public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed): void`
`38`	`35`	`{`
`39`	`36`	`if (!isset($this->tokens[$series])) {`
`40`	`37`	`throw new TokenNotFoundException('No token found.');`
`@@ -50,18 +47,12 @@ public function updateToken(string $series, #[\SensitiveParameter] string $token`
`50`	`47`	`$this->tokens[$series] = $token;`
`51`	`48`	`}`
`52`	`49`
`53`		`- /**`
`54`		`- * @return void`
`55`		`- */`
`56`		`- public function deleteTokenBySeries(string $series)`
	`50`	`+ public function deleteTokenBySeries(string $series): void`
`57`	`51`	`{`
`58`	`52`	`unset($this->tokens[$series]);`
`59`	`53`	`}`
`60`	`54`
`61`		`- /**`
`62`		`- * @return void`
`63`		`- */`
`64`		`- public function createNewToken(PersistentTokenInterface $token)`
	`55`	`+ public function createNewToken(PersistentTokenInterface $token): void`
`65`	`56`	`{`
`66`	`57`	`$this->tokens[$token->getSeries()] = $token;`
`67`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,18 +53,12 @@ public function getUser(): ?UserInterface`
`53`	`53`	`return $this->user;`
`54`	`54`	`}`
`55`	`55`
`56`		`- /**`
`57`		`- * @return void`
`58`		`- */`
`59`		`- public function setUser(UserInterface $user)`
	`56`	`+ public function setUser(UserInterface $user): void`
`60`	`57`	`{`
`61`	`58`	`$this->user = $user;`
`62`	`59`	`}`
`63`	`60`
`64`		`- /**`
`65`		`- * @return void`
`66`		`- */`
`67`		`- public function eraseCredentials()`
	`61`	`+ public function eraseCredentials(): void`
`68`	`62`	`{`
`69`	`63`	`if ($this->getUser() instanceof UserInterface) {`
`70`	`64`	`$this->getUser()->eraseCredentials();`
`@@ -118,10 +112,7 @@ public function getAttributes(): array`
`118`	`112`	`return $this->attributes;`
`119`	`113`	`}`
`120`	`114`
`121`		`- /**`
`122`		`- * @return void`
`123`		`- */`
`124`		`- public function setAttributes(array $attributes)`
	`115`	`+ public function setAttributes(array $attributes): void`
`125`	`116`	`{`
`126`	`117`	`$this->attributes = $attributes;`
`127`	`118`	`}`
`@@ -140,10 +131,7 @@ public function getAttribute(string $name): mixed`
`140`	`131`	`return $this->attributes[$name];`
`141`	`132`	`}`
`142`	`133`
`143`		`- /**`
`144`		`- * @return void`
`145`		`- */`
`146`		`- public function setAttribute(string $name, mixed $value)`
	`134`	`+ public function setAttribute(string $name, mixed $value): void`
`147`	`135`	`{`
`148`	`136`	`$this->attributes[$name] = $value;`
`149`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,7 @@ public function getUser(): ?UserInterface`
`33`	`33`	`return null;`
`34`	`34`	`}`
`35`	`35`
`36`		`- /**`
`37`		`- * @return never`
`38`		`- */`
`39`		`- public function setUser(UserInterface $user)`
	`36`	`+ public function setUser(UserInterface $user): never`
`40`	`37`	`{`
`41`	`38`	`throw new \BadMethodCallException('Cannot set user on a NullToken.');`
`42`	`39`	`}`
`@@ -46,10 +43,7 @@ public function getUserIdentifier(): string`
`46`	`43`	`return '';`
`47`	`44`	`}`
`48`	`45`
`49`		`- /**`
`50`		`- * @return void`
`51`		`- */`
`52`		`- public function eraseCredentials()`
	`46`	`+ public function eraseCredentials(): void`
`53`	`47`	`{`
`54`	`48`	`}`
`55`	`49`
`@@ -58,10 +52,7 @@ public function getAttributes(): array`
`58`	`52`	`return [];`
`59`	`53`	`}`
`60`	`54`
`61`		`- /**`
`62`		`- * @return never`
`63`		`- */`
`64`		`- public function setAttributes(array $attributes)`
	`55`	`+ public function setAttributes(array $attributes): never`
`65`	`56`	`{`
`66`	`57`	`throw new \BadMethodCallException('Cannot set attributes of NullToken.');`
`67`	`58`	`}`
`@@ -76,10 +67,7 @@ public function getAttribute(string $name): mixed`
`76`	`67`	`return null;`
`77`	`68`	`}`
`78`	`69`
`79`		`- /**`
`80`		`- * @return never`
`81`		`- */`
`82`		`- public function setAttribute(string $name, mixed $value)`
	`70`	`+ public function setAttribute(string $name, mixed $value): never`
`83`	`71`	`{`
`84`	`72`	`throw new \BadMethodCallException('Cannot add attribute to NullToken.');`
`85`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,7 @@ public function getToken(): ?TokenInterface`
`37`	`37`	`return $this->token;`
`38`	`38`	`}`
`39`	`39`
`40`		`- /**`
`41`		`- * @return void`
`42`		`- */`
`43`		`- public function setToken(?TokenInterface $token)`
	`40`	`+ public function setToken(?TokenInterface $token): void`
`44`	`41`	`{`
`45`	`42`	`if ($token) {`
`46`	`43`	`// ensure any initializer is called`
`@@ -56,10 +53,7 @@ public function setInitializer(?callable $initializer): void`
`56`	`53`	`$this->initializer = null === $initializer ? null : $initializer(...);`
`57`	`54`	`}`
`58`	`55`
`59`		`- /**`
`60`		`- * @return void`
`61`		`- */`
`62`		`- public function reset()`
	`56`	`+ public function reset(): void`
`63`	`57`	`{`
`64`	`58`	`$this->setToken(null);`
`65`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@ public function getToken(): ?TokenInterface;`
`29`	`29`	`* Sets the authentication token.`
`30`	`30`	`*`
`31`	`31`	`* @param TokenInterface\|null $token A TokenInterface token, or null if no further authentication information should be stored`
`32`		`- *`
`33`		`- * @return void`
`34`	`32`	`*/`
`35`		`- public function setToken(?TokenInterface $token);`
	`33`	`+ public function setToken(?TokenInterface $token): void;`
`36`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,10 +31,7 @@ public function __construct(RoleHierarchyInterface $roleHierarchy, string $prefi`
`31`	`31`	`parent::__construct($prefix);`
`32`	`32`	`}`
`33`	`33`
`34`		`- /**`
`35`		`- * @return array`
`36`		`- */`
`37`		`- protected function extractRoles(TokenInterface $token)`
	`34`	`+ protected function extractRoles(TokenInterface $token): array`
`38`	`35`	`{`
`39`	`36`	`return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());`
`40`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,10 +58,7 @@ public function supportsType(string $subjectType): bool`
`58`	`58`	`return true;`
`59`	`59`	`}`
`60`	`60`
`61`		`- /**`
`62`		`- * @return array`
`63`		`- */`
`64`		`- protected function extractRoles(TokenInterface $token)`
	`61`	`+ protected function extractRoles(TokenInterface $token): array`
`65`	`62`	`{`
`66`	`63`	`return $token->getRoleNames();`
`67`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,7 @@ public function __construct(TokenInterface $token)`
`28`	`28`	`$this->authenticationToken = $token;`
`29`	`29`	`}`
`30`	`30`
`31`		`- /**`
`32`		`- * @return TokenInterface`
`33`		`- */`
`34`		`- public function getAuthenticationToken()`
	`31`	`+ public function getAuthenticationToken(): TokenInterface`
`35`	`32`	`{`
`36`	`33`	`return $this->authenticationToken;`
`37`	`34`	`}`