[Security] phpdoc cleanups

Author: nicolas-grekas

Authentication/RememberMe/PersistentTokenInterface.php

@@ -15,7 +15,7 @@
  * Interface to be implemented by persistent token classes (such as
  * Doctrine entities representing a remember-me token).
  *
- * @method string getUserIdentifier() returns the identifier used to authenticate (e.g. their e-mailaddress or username)
+ * @method string getUserIdentifier() returns the identifier used to authenticate (e.g. their email address or username)
  *
  * @author Johannes M. Schmitt <[email protected]>
  */

Authentication/Token/AbstractToken.php

@@ -66,6 +66,9 @@ public function getUsername(/* $legacy = true */)
         return (string) $this->user;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getUserIdentifier(): string
     {
         // method returns "null" in non-legacy mode if not overridden
@@ -208,41 +211,31 @@ public function __unserialize(array $data): void
     }
 
     /**
-     * Returns the token attributes.
-     *
-     * @return array
+     * {@inheritdoc}
      */
     public function getAttributes()
     {
         return $this->attributes;
     }
 
     /**
-     * Sets the token attributes.
-     *
-     * @param array $attributes The token attributes
+     * {@inheritdoc}
      */
     public function setAttributes(array $attributes)
     {
         $this->attributes = $attributes;
     }
 
     /**
-     * Returns true if the attribute exists.
-     *
-     * @return bool
+     * {@inheritdoc}
      */
     public function hasAttribute(string $name)
     {
         return \array_key_exists($name, $this->attributes);
     }
 
     /**
-     * Returns an attribute value.
-     *
-     * @return mixed
-     *
-     * @throws \InvalidArgumentException When attribute doesn't exist for this token
+     * {@inheritdoc}
      */
     public function getAttribute(string $name)
     {
@@ -254,9 +247,7 @@ public function getAttribute(string $name)
     }
 
     /**
-     * Sets an attribute.
-     *
-     * @param mixed $value The attribute value
+     * {@inheritdoc}
      */
     public function setAttribute(string $name, $value)
     {

Authentication/Token/RememberMeToken.php

@@ -81,8 +81,6 @@ public function getFirewallName(): string
     }
 
     /**
-     * Returns the secret.
-     *
      * @return string
      */
     public function getSecret()

Authentication/Token/TokenInterface.php

@@ -16,7 +16,7 @@
 /**
  * TokenInterface is the interface for the user authentication information.
  *
- * @method string getUserIdentifier() returns the user identifier used during authentication (e.g. a user's e-mailaddress or username)
+ * @method string getUserIdentifier() returns the user identifier used during authentication (e.g. a user's email address or username)
  *
  * @author Fabien Potencier <[email protected]>
  * @author Johannes M. Schmitt <[email protected]>
@@ -44,7 +44,7 @@ public function getRoleNames(): array;
      *
      * @return mixed
      *
-     * @deprecated since 5.4
+     * @deprecated since Symfony 5.4
      */
     public function getCredentials();
 
@@ -88,38 +88,28 @@ public function setAuthenticated(bool $isAuthenticated);
     public function eraseCredentials();
 
     /**
-     * Returns the token attributes.
-     *
      * @return array
      */
     public function getAttributes();
 
     /**
-     * Sets the token attributes.
-     *
      * @param array $attributes The token attributes
      */
     public function setAttributes(array $attributes);
 
     /**
-     * Returns true if the attribute exists.
-     *
      * @return bool
      */
     public function hasAttribute(string $name);
 
     /**
-     * Returns an attribute value.
-     *
      * @return mixed
      *
      * @throws \InvalidArgumentException When attribute doesn't exist for this token
      */
     public function getAttribute(string $name);
 
     /**
-     * Sets an attribute.
-     *
      * @param mixed $value The attribute value
      */
     public function setAttribute(string $name, $value);

Exception/AuthenticationException.php

@@ -24,8 +24,6 @@ class AuthenticationException extends RuntimeException
     private $token;
 
     /**
-     * Get the token.
-     *
      * @return TokenInterface|null
      */
     public function getToken()

Exception/UserNotFoundException.php

@@ -30,7 +30,7 @@ public function getMessageKey()
     }
 
     /**
-     * Get the user identifier (e.g. username or e-mailaddress).
+     * Get the user identifier (e.g. username or email address).
      */
     public function getUserIdentifier(): ?string
     {
@@ -50,7 +50,7 @@ public function getUsername()
     }
 
     /**
-     * Set the user identifier (e.g. username or e-mailaddress).
+     * Set the user identifier (e.g. username or email address).
      */
     public function setUserIdentifier(string $identifier): void
     {

User/User.php

@@ -91,7 +91,7 @@ public function getUsername(): string
     }
 
     /**
-     * Returns the identifier for this user (e.g. its username or e-mailaddress).
+     * Returns the identifier for this user (e.g. its username or email address).
      */
     public function getUserIdentifier(): string
     {

User/UserInterface.php

@@ -26,7 +26,7 @@
  *
  * @see UserProviderInterface
  *
- * @method string getUserIdentifier() returns the identifier for this user (e.g. its username or e-mailaddress)
+ * @method string getUserIdentifier() returns the identifier for this user (e.g. its username or email address)
  *
  * @author Fabien Potencier <[email protected]>
  */

User/UserProviderInterface.php

@@ -18,7 +18,7 @@
  * Represents a class that loads UserInterface objects from some source for the authentication system.
  *
  * In a typical authentication configuration, a user identifier (e.g. a
- * username or e-mailaddress) credential enters the system (via form login, or
+ * username or email address) credential enters the system (via form login, or
  * any method). The user provider that is configured with that authentication
  * method is asked to load the UserInterface object for the given identifier (via
  * loadUserByIdentifier) so that the rest of the process can continue.