minor #20800 [Security] fix the docblock in regard to the role argument (xabbuh)

fabpot · fabpot · commit 7a07c1b46413 · 2016-12-07T09:06:36.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- [Security] fix the docblock in regard to the role argument | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Makes the docblocks consistent with the `UserInterface` since #17525. Commits ------- 4e563ae fix the docblock in regard to the role argument
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php
@@ -33,7 +33,7 @@ abstract class AbstractToken implements TokenInterface
     /**
      * Constructor.
      *
-     * @param RoleInterface[]|string[] $roles An array of roles
+     * @param (RoleInterface|string)[] $roles An array of roles
      *
      * @throws \InvalidArgumentException
      */
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php
@@ -29,7 +29,7 @@ class PreAuthenticatedToken extends AbstractToken
      * @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
+     * @param (RoleInterface|string)[] $roles       An array of roles
      */
     public function __construct($user, $credentials, $providerKey, array $roles = array())
     {
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php
@@ -29,7 +29,7 @@ class UsernamePasswordToken extends AbstractToken
      * @param string|object            $user        The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
      * @param string                   $credentials This usually is the password of the user
      * @param string                   $providerKey The provider key
-     * @param RoleInterface[]|string[] $roles       An array of roles
+     * @param (RoleInterface|string)[] $roles       An array of roles
      *
      * @throws \InvalidArgumentException
      */

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ abstract class AbstractToken implements TokenInterface`
`33`	`33`	`/**`
`34`	`34`	`* Constructor.`
`35`	`35`	`*`
`36`		`- * @param RoleInterface[]\|string[] $roles An array of roles`
	`36`	`+ * @param (RoleInterface\|string)[] $roles An array of roles`
`37`	`37`	`*`
`38`	`38`	`* @throws \InvalidArgumentException`
`39`	`39`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class PreAuthenticatedToken extends AbstractToken`
`29`	`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`		`- * @param RoleInterface[]\|string[] $roles An array of roles`
	`32`	`+ * @param (RoleInterface\|string)[] $roles An array of roles`
`33`	`33`	`*/`
`34`	`34`	`public function __construct($user, $credentials, $providerKey, array $roles = array())`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class UsernamePasswordToken extends AbstractToken`
`29`	`29`	`* @param string\|object $user The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method`
`30`	`30`	`* @param string $credentials This usually is the password of the user`
`31`	`31`	`* @param string $providerKey The provider key`
`32`		`- * @param RoleInterface[]\|string[] $roles An array of roles`
	`32`	`+ * @param (RoleInterface\|string)[] $roles An array of roles`
`33`	`33`	`*`
`34`	`34`	`* @throws \InvalidArgumentException`
`35`	`35`	`*/`