minor #32257 [Security] [Guard] Removed useless param annotations (thomasbisignani)

fabpot · fabpot · commit 081c60124318 · 2019-06-30T15:25:31.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- [Security] [Guard] Removed useless param annotations | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32254 (comment) | License | MIT | Doc PR | The PR removes useless `@param` annotation, it is linked with the #32254 (comment) Commits ------- 848e881 [Security] [Guard] Removed useless param annotations
diff --git a/src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php b/src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php
@@ -36,8 +36,7 @@ public function supports(Request $request)
      * Shortcut to create a PostAuthenticationGuardToken for you, if you don't really
      * care about which authenticated token you're using.
      *
-     * @param UserInterface $user
-     * @param string        $providerKey
+     * @param string $providerKey
      *
      * @return PostAuthenticationGuardToken
      */
diff --git a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@@ -55,9 +55,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
     /**
      * Override to change what happens after successful authentication.
      *
-     * @param Request        $request
-     * @param TokenInterface $token
-     * @param string         $providerKey
+     * @param string $providerKey
      *
      * @return RedirectResponse
      */
diff --git a/src/Symfony/Component/Security/Guard/AuthenticatorInterface.php b/src/Symfony/Component/Security/Guard/AuthenticatorInterface.php
@@ -30,8 +30,6 @@ interface AuthenticatorInterface extends GuardAuthenticatorInterface
      *
      * If this returns false, the authenticator will be skipped.
      *
-     * @param Request $request
-     *
      * @return bool
      */
     public function supports(Request $request);
@@ -53,8 +51,6 @@ public function supports(Request $request);
      *
      *      return ['api_key' => $request->headers->get('X-API-TOKEN')];
      *
-     * @param Request $request
-     *
      * @return mixed Any non-null value
      *
      * @throws \UnexpectedValueException If null is returned
diff --git a/src/Symfony/Component/Security/Guard/GuardAuthenticatorHandler.php b/src/Symfony/Component/Security/Guard/GuardAuthenticatorHandler.php
@@ -70,10 +70,7 @@ public function authenticateWithToken(TokenInterface $token, Request $request/*,
     /**
      * Returns the "on success" response for the given GuardAuthenticator.
      *
-     * @param TokenInterface         $token
-     * @param Request                $request
-     * @param AuthenticatorInterface $guardAuthenticator
-     * @param string                 $providerKey        The provider (i.e. firewall) key
+     * @param string $providerKey The provider (i.e. firewall) key
      *
      * @return Response|null
      */
@@ -93,10 +90,7 @@ public function handleAuthenticationSuccess(TokenInterface $token, Request $requ
      * Convenience method for authenticating the user and returning the
      * Response *if any* for success.
      *
-     * @param UserInterface          $user
-     * @param Request                $request
-     * @param AuthenticatorInterface $authenticator
-     * @param string                 $providerKey   The provider (i.e. firewall) key
+     * @param string $providerKey The provider (i.e. firewall) key
      *
      * @return Response|null
      */
@@ -115,10 +109,7 @@ public function authenticateUserAndHandleSuccess(UserInterface $user, Request $r
      * Handles an authentication failure and returns the Response for the
      * GuardAuthenticator.
      *
-     * @param AuthenticationException $authenticationException
-     * @param Request                 $request
-     * @param AuthenticatorInterface  $guardAuthenticator
-     * @param string                  $providerKey             The key of the firewall
+     * @param string $providerKey The provider (i.e. firewall) key
      *
      * @return Response|null
      */
diff --git a/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php b/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php
@@ -55,8 +55,6 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
      *
      *     return ['api_key' => $request->headers->get('X-API-TOKEN')];
      *
-     * @param Request $request
-     *
      * @return mixed|null
      */
     public function getCredentials(Request $request);
@@ -69,9 +67,6 @@ public function getCredentials(Request $request);
      * You may throw an AuthenticationException if you wish. If you return
      * null, then a UsernameNotFoundException is thrown for you.
      *
-     * @param mixed                 $credentials
-     * @param UserProviderInterface $userProvider
-     *
      * @throws AuthenticationException
      *
      * @return UserInterface|null
@@ -87,9 +82,6 @@ public function getUser($credentials, UserProviderInterface $userProvider);
      *
      * The *credentials* are the return value from getCredentials()
      *
-     * @param mixed         $credentials
-     * @param UserInterface $user
-     *
      * @return bool
      *
      * @throws AuthenticationException
@@ -105,8 +97,7 @@ public function checkCredentials($credentials, UserInterface $user);
      *
      * @see AbstractGuardAuthenticator
      *
-     * @param UserInterface $user
-     * @param string        $providerKey The provider (i.e. firewall) key
+     * @param string $providerKey The provider (i.e. firewall) key
      *
      * @return GuardTokenInterface
      */
@@ -121,9 +112,6 @@ public function createAuthenticatedToken(UserInterface $user, $providerKey);
      * If you return null, the request will continue, but the user will
      * not be authenticated. This is probably not what you want to do.
      *
-     * @param Request                 $request
-     * @param AuthenticationException $exception
-     *
      * @return Response|null
      */
     public function onAuthenticationFailure(Request $request, AuthenticationException $exception);
@@ -137,9 +125,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
      * If you return null, the current request will continue, and the user
      * will be authenticated. This makes sense, for example, with an API.
      *
-     * @param Request        $request
-     * @param TokenInterface $token
-     * @param string         $providerKey The provider (i.e. firewall) key
+     * @param string $providerKey The provider (i.e. firewall) key
      *
      * @return Response|null
      */

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,7 @@ public function supports(Request $request)`
`36`	`36`	`* Shortcut to create a PostAuthenticationGuardToken for you, if you don't really`
`37`	`37`	`* care about which authenticated token you're using.`
`38`	`38`	`*`
`39`		`- * @param UserInterface $user`
`40`		`- * @param string $providerKey`
	`39`	`+ * @param string $providerKey`
`41`	`40`	`*`
`42`	`41`	`* @return PostAuthenticationGuardToken`
`43`	`42`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -55,9 +55,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio`
`55`	`55`	`/**`
`56`	`56`	`* Override to change what happens after successful authentication.`
`57`	`57`	`*`
`58`		`- * @param Request $request`
`59`		`- * @param TokenInterface $token`
`60`		`- * @param string $providerKey`
	`58`	`+ * @param string $providerKey`
`61`	`59`	`*`
`62`	`60`	`* @return RedirectResponse`
`63`	`61`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,6 @@ interface AuthenticatorInterface extends GuardAuthenticatorInterface`
`30`	`30`	`*`
`31`	`31`	`* If this returns false, the authenticator will be skipped.`
`32`	`32`	`*`
`33`		`- * @param Request $request`
`34`		`- *`
`35`	`33`	`* @return bool`
`36`	`34`	`*/`
`37`	`35`	`public function supports(Request $request);`
`@@ -53,8 +51,6 @@ public function supports(Request $request);`
`53`	`51`	`*`
`54`	`52`	`* return ['api_key' => $request->headers->get('X-API-TOKEN')];`
`55`	`53`	`*`
`56`		`- * @param Request $request`
`57`		`- *`
`58`	`54`	`* @return mixed Any non-null value`
`59`	`55`	`*`
`60`	`56`	`* @throws \UnexpectedValueException If null is returned`
Original file line number	Diff line number	Diff line change
`@@ -70,10 +70,7 @@ public function authenticateWithToken(TokenInterface $token, Request $request/*,`
`70`	`70`	`/**`
`71`	`71`	`* Returns the "on success" response for the given GuardAuthenticator.`
`72`	`72`	`*`
`73`		`- * @param TokenInterface $token`
`74`		`- * @param Request $request`
`75`		`- * @param AuthenticatorInterface $guardAuthenticator`
`76`		`- * @param string $providerKey The provider (i.e. firewall) key`
	`73`	`+ * @param string $providerKey The provider (i.e. firewall) key`
`77`	`74`	`*`
`78`	`75`	`* @return Response\|null`
`79`	`76`	`*/`
`@@ -93,10 +90,7 @@ public function handleAuthenticationSuccess(TokenInterface $token, Request $requ`
`93`	`90`	`* Convenience method for authenticating the user and returning the`
`94`	`91`	`* Response if any for success.`
`95`	`92`	`*`
`96`		`- * @param UserInterface $user`
`97`		`- * @param Request $request`
`98`		`- * @param AuthenticatorInterface $authenticator`
`99`		`- * @param string $providerKey The provider (i.e. firewall) key`
	`93`	`+ * @param string $providerKey The provider (i.e. firewall) key`
`100`	`94`	`*`
`101`	`95`	`* @return Response\|null`
`102`	`96`	`*/`
`@@ -115,10 +109,7 @@ public function authenticateUserAndHandleSuccess(UserInterface $user, Request $r`
`115`	`109`	`* Handles an authentication failure and returns the Response for the`
`116`	`110`	`* GuardAuthenticator.`
`117`	`111`	`*`
`118`		`- * @param AuthenticationException $authenticationException`
`119`		`- * @param Request $request`
`120`		`- * @param AuthenticatorInterface $guardAuthenticator`
`121`		`- * @param string $providerKey The key of the firewall`
	`112`	`+ * @param string $providerKey The provider (i.e. firewall) key`
`122`	`113`	`*`
`123`	`114`	`* @return Response\|null`
`124`	`115`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,6 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface`
`55`	`55`	`*`
`56`	`56`	`* return ['api_key' => $request->headers->get('X-API-TOKEN')];`
`57`	`57`	`*`
`58`		`- * @param Request $request`
`59`		`- *`
`60`	`58`	`* @return mixed\|null`
`61`	`59`	`*/`
`62`	`60`	`public function getCredentials(Request $request);`
`@@ -69,9 +67,6 @@ public function getCredentials(Request $request);`
`69`	`67`	`* You may throw an AuthenticationException if you wish. If you return`
`70`	`68`	`* null, then a UsernameNotFoundException is thrown for you.`
`71`	`69`	`*`
`72`		`- * @param mixed $credentials`
`73`		`- * @param UserProviderInterface $userProvider`
`74`		`- *`
`75`	`70`	`* @throws AuthenticationException`
`76`	`71`	`*`
`77`	`72`	`* @return UserInterface\|null`
`@@ -87,9 +82,6 @@ public function getUser($credentials, UserProviderInterface $userProvider);`
`87`	`82`	`*`
`88`	`83`	`* The credentials are the return value from getCredentials()`
`89`	`84`	`*`
`90`		`- * @param mixed $credentials`
`91`		`- * @param UserInterface $user`
`92`		`- *`
`93`	`85`	`* @return bool`
`94`	`86`	`*`
`95`	`87`	`* @throws AuthenticationException`
`@@ -105,8 +97,7 @@ public function checkCredentials($credentials, UserInterface $user);`
`105`	`97`	`*`
`106`	`98`	`* @see AbstractGuardAuthenticator`
`107`	`99`	`*`
`108`		`- * @param UserInterface $user`
`109`		`- * @param string $providerKey The provider (i.e. firewall) key`
	`100`	`+ * @param string $providerKey The provider (i.e. firewall) key`
`110`	`101`	`*`
`111`	`102`	`* @return GuardTokenInterface`
`112`	`103`	`*/`
`@@ -121,9 +112,6 @@ public function createAuthenticatedToken(UserInterface $user, $providerKey);`
`121`	`112`	`* If you return null, the request will continue, but the user will`
`122`	`113`	`* not be authenticated. This is probably not what you want to do.`
`123`	`114`	`*`
`124`		`- * @param Request $request`
`125`		`- * @param AuthenticationException $exception`
`126`		`- *`
`127`	`115`	`* @return Response\|null`
`128`	`116`	`*/`
`129`	`117`	`public function onAuthenticationFailure(Request $request, AuthenticationException $exception);`
`@@ -137,9 +125,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio`
`137`	`125`	`* If you return null, the current request will continue, and the user`
`138`	`126`	`* will be authenticated. This makes sense, for example, with an API.`
`139`	`127`	`*`
`140`		`- * @param Request $request`
`141`		`- * @param TokenInterface $token`
`142`		`- * @param string $providerKey The provider (i.e. firewall) key`
	`128`	`+ * @param string $providerKey The provider (i.e. firewall) key`
`143`	`129`	`*`
`144`	`130`	`* @return Response\|null`
`145`	`131`	`*/`