minor #27940 [Security] Update user phpdoc on tokens (ro0NL)

fabpot · fabpot · commit 091f9ff386dd · 2018-07-13T22:20:16.000+02:00
This PR was squashed before being merged into the 2.8 branch (closes #27940). Discussion ---------- [Security] Update user phpdoc on tokens | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  As implemented here: https://github.com/symfony/symfony/blob/1e16a8b979683a7136d30e37eec7b401586ad940/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php#L78-L88 Note IMHO `string|object` is intended, and used consistently elsewhere, e.g.: https://github.com/symfony/symfony/blob/f80376217d33490fcb9592262c5ac5a08519a7f9/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php#L27 Commits ------- 7306018 [Security] Update user phpdoc on tokens
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php
@@ -77,14 +77,7 @@ public function getUser()
     }
 
     /**
-     * Sets the user in the token.
-     *
-     * The user can be a UserInterface instance, or an object implementing
-     * a __toString method or the username as a regular string.
-     *
-     * @param string|object $user The user
-     *
-     * @throws \InvalidArgumentException
+     * {@inheritdoc}
      */
     public function setUser($user)
     {
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php
@@ -47,17 +47,22 @@ public function getCredentials();
     /**
      * Returns a user representation.
      *
-     * @return mixed Can be a UserInterface instance, an object implementing a __toString method,
-     *               or the username as a regular string
+     * @return string|object Can be a UserInterface instance, an object implementing a __toString method,
+     *                       or the username as a regular string
      *
      * @see AbstractToken::setUser()
      */
     public function getUser();
 
     /**
-     * Sets a user.
+     * Sets the user in the token.
      *
-     * @param mixed $user
+     * The user can be a UserInterface instance, or an object implementing
+     * a __toString method or the username as a regular string.
+     *
+     * @param string|object $user The user
+     *
+     * @throws \InvalidArgumentException
      */
     public function setUser($user);
 
