minor #18727 [2.3][Component/Security] Fixed phpdoc in AnonymousToken constructor for user param (eriwin)

fabpot · fabpot · commit bdc99de4bc4e · 2016-05-09T12:47:57.000-05:00
This PR was squashed before being merged into the 2.3 branch (closes #18727). Discussion ---------- [2.3][Component/Security] Fixed phpdoc in AnonymousToken constructor for user param | Q | A | ------------- | --- | Branch? | 2.3 | Bug fix? | yes, phpdoc one | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Updated phpdoc of AnonymousToken $user param from string to string|object since an object is allowed to in the parent AbstractToken: https://github.com/symfony/symfony/blob/2.3/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php#L91 Commits ------- b1c60b4 [2.3][Component/Security] Fixed phpdoc in AnonymousToken constructor for user param
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AnonymousToken.php
@@ -26,7 +26,7 @@ class AnonymousToken extends AbstractToken
      * Constructor.
      *
      * @param string          $key   The key shared with the authentication provider
-     * @param string          $user  The user
+     * @param string|object   $user  The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.
      * @param RoleInterface[] $roles An array of roles
      */
     public function __construct($key, $user, array $roles = array())
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php
@@ -26,7 +26,7 @@ class PreAuthenticatedToken extends AbstractToken
     /**
      * Constructor.
      *
-     * @param string|object            $user        The user
+     * @param string|object            $user        The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.
      * @param mixed                    $credentials The user credentials
      * @param string                   $providerKey The provider key
      * @param RoleInterface[]|string[] $roles       An array of roles

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class AnonymousToken extends AbstractToken`
`26`	`26`	`* Constructor.`
`27`	`27`	`*`
`28`	`28`	`* @param string $key The key shared with the authentication provider`
`29`		`- * @param string $user The user`
	`29`	`+ * @param string\|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.`
`30`	`30`	`* @param RoleInterface[] $roles An array of roles`
`31`	`31`	`*/`
`32`	`32`	`public function __construct($key, $user, array $roles = array())`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class PreAuthenticatedToken extends AbstractToken`
`26`	`26`	`/**`
`27`	`27`	`* Constructor.`
`28`	`28`	`*`
`29`		`- * @param string\|object $user The user`
	`29`	`+ * @param string\|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.`
`30`	`30`	`* @param mixed $credentials The user credentials`
`31`	`31`	`* @param string $providerKey The provider key`
`32`	`32`	`* @param RoleInterface[]\|string[] $roles An array of roles`