Remove superfluous phpdoc tags

Philippe Segatori · nicolas-grekas · commit 57ad39e1052c · 2019-08-14T13:59:53.000+02:00
diff --git a/Authentication/DefaultAuthenticationSuccessHandler.php b/Authentication/DefaultAuthenticationSuccessHandler.php
@@ -40,8 +40,7 @@ class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandle
     ];
 
     /**
-     * @param HttpUtils $httpUtils
-     * @param array     $options   Options for processing a successful authentication attempt
+     * @param array $options Options for processing a successful authentication attempt
      */
     public function __construct(HttpUtils $httpUtils, array $options = [])
     {
diff --git a/EntryPoint/FormAuthenticationEntryPoint.php b/EntryPoint/FormAuthenticationEntryPoint.php
@@ -29,10 +29,9 @@ class FormAuthenticationEntryPoint implements AuthenticationEntryPointInterface
     private $httpUtils;
 
     /**
-     * @param HttpKernelInterface $kernel
-     * @param HttpUtils           $httpUtils  An HttpUtils instance
-     * @param string              $loginPath  The path to the login form
-     * @param bool                $useForward Whether to forward or redirect to the login form
+     * @param HttpUtils $httpUtils  An HttpUtils instance
+     * @param string    $loginPath  The path to the login form
+     * @param bool      $useForward Whether to forward or redirect to the login form
      */
     public function __construct(HttpKernelInterface $kernel, HttpUtils $httpUtils, $loginPath, $useForward = false)
     {
diff --git a/Firewall/AbstractAuthenticationListener.php b/Firewall/AbstractAuthenticationListener.php
@@ -64,17 +64,14 @@ abstract class AbstractAuthenticationListener implements ListenerInterface
     private $rememberMeServices;
 
     /**
-     * @param TokenStorageInterface                  $tokenStorage          A TokenStorageInterface instance
-     * @param AuthenticationManagerInterface         $authenticationManager An AuthenticationManagerInterface instance
-     * @param SessionAuthenticationStrategyInterface $sessionStrategy
-     * @param HttpUtils                              $httpUtils             An HttpUtils instance
-     * @param string                                 $providerKey
-     * @param AuthenticationSuccessHandlerInterface  $successHandler
-     * @param AuthenticationFailureHandlerInterface  $failureHandler
-     * @param array                                  $options               An array of options for the processing of a
-     *                                                                      successful, or failed authentication attempt
-     * @param LoggerInterface|null                   $logger                A LoggerInterface instance
-     * @param EventDispatcherInterface|null          $dispatcher            An EventDispatcherInterface instance
+     * @param TokenStorageInterface          $tokenStorage          A TokenStorageInterface instance
+     * @param AuthenticationManagerInterface $authenticationManager An AuthenticationManagerInterface instance
+     * @param HttpUtils                      $httpUtils             An HttpUtils instance
+     * @param string                         $providerKey
+     * @param array                          $options               An array of options for the processing of a
+     *                                                              successful, or failed authentication attempt
+     * @param LoggerInterface|null           $logger                A LoggerInterface instance
+     * @param EventDispatcherInterface|null  $dispatcher            An EventDispatcherInterface instance
      *
      * @throws \InvalidArgumentException
      */
diff --git a/Firewall/LogoutListener.php b/Firewall/LogoutListener.php
@@ -38,7 +38,6 @@ class LogoutListener implements ListenerInterface
     private $csrfTokenManager;
 
     /**
-     * @param TokenStorageInterface          $tokenStorage
      * @param HttpUtils                      $httpUtils        An HttpUtils instance
      * @param LogoutSuccessHandlerInterface  $successHandler   A LogoutSuccessHandlerInterface instance
      * @param array                          $options          An array of options to process a logout attempt
diff --git a/Firewall/RememberMeListener.php b/Firewall/RememberMeListener.php
@@ -39,13 +39,7 @@ class RememberMeListener implements ListenerInterface
     private $sessionStrategy;
 
     /**
-     * @param TokenStorageInterface                       $tokenStorage
-     * @param RememberMeServicesInterface                 $rememberMeServices
-     * @param AuthenticationManagerInterface              $authenticationManager
-     * @param LoggerInterface|null                        $logger
-     * @param EventDispatcherInterface|null               $dispatcher
-     * @param bool                                        $catchExceptions
-     * @param SessionAuthenticationStrategyInterface|null $sessionStrategy
+     * @param bool $catchExceptions
      */
     public function __construct(TokenStorageInterface $tokenStorage, RememberMeServicesInterface $rememberMeServices, AuthenticationManagerInterface $authenticationManager, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, $catchExceptions = true, SessionAuthenticationStrategyInterface $sessionStrategy = null)
     {
diff --git a/Firewall/SimpleFormAuthenticationListener.php b/Firewall/SimpleFormAuthenticationListener.php
@@ -38,19 +38,16 @@ class SimpleFormAuthenticationListener extends AbstractAuthenticationListener
     private $csrfTokenManager;
 
     /**
-     * @param TokenStorageInterface                  $tokenStorage          A TokenStorageInterface instance
-     * @param AuthenticationManagerInterface         $authenticationManager An AuthenticationManagerInterface instance
-     * @param SessionAuthenticationStrategyInterface $sessionStrategy
-     * @param HttpUtils                              $httpUtils             An HttpUtils instance
-     * @param string                                 $providerKey
-     * @param AuthenticationSuccessHandlerInterface  $successHandler
-     * @param AuthenticationFailureHandlerInterface  $failureHandler
-     * @param array                                  $options               An array of options for the processing of a
-     *                                                                      successful, or failed authentication attempt
-     * @param LoggerInterface|null                   $logger                A LoggerInterface instance
-     * @param EventDispatcherInterface|null          $dispatcher            An EventDispatcherInterface instance
-     * @param CsrfTokenManagerInterface|null         $csrfTokenManager      A CsrfTokenManagerInterface instance
-     * @param SimpleFormAuthenticatorInterface|null  $simpleAuthenticator   A SimpleFormAuthenticatorInterface instance
+     * @param TokenStorageInterface                 $tokenStorage          A TokenStorageInterface instance
+     * @param AuthenticationManagerInterface        $authenticationManager An AuthenticationManagerInterface instance
+     * @param HttpUtils                             $httpUtils             An HttpUtils instance
+     * @param string                                $providerKey
+     * @param array                                 $options               An array of options for the processing of a
+     *                                                                     successful, or failed authentication attempt
+     * @param LoggerInterface|null                  $logger                A LoggerInterface instance
+     * @param EventDispatcherInterface|null         $dispatcher            An EventDispatcherInterface instance
+     * @param CsrfTokenManagerInterface|null        $csrfTokenManager      A CsrfTokenManagerInterface instance
+     * @param SimpleFormAuthenticatorInterface|null $simpleAuthenticator   A SimpleFormAuthenticatorInterface instance
      *
      * @throws \InvalidArgumentException In case no simple authenticator is provided
      */
diff --git a/Logout/DefaultLogoutSuccessHandler.php b/Logout/DefaultLogoutSuccessHandler.php
@@ -26,8 +26,7 @@ class DefaultLogoutSuccessHandler implements LogoutSuccessHandlerInterface
     protected $targetUrl;
 
     /**
-     * @param HttpUtils $httpUtils
-     * @param string    $targetUrl
+     * @param string $targetUrl
      */
     public function __construct(HttpUtils $httpUtils, $targetUrl = '/')
     {
diff --git a/Logout/LogoutUrlGenerator.php b/Logout/LogoutUrlGenerator.php
@@ -46,7 +46,6 @@ public function __construct(RequestStack $requestStack = null, UrlGeneratorInter
      * @param string                         $csrfTokenId      The ID of the CSRF token
      * @param string                         $csrfParameter    The CSRF token parameter name
      * @param CsrfTokenManagerInterface|null $csrfTokenManager A CsrfTokenManagerInterface instance
-     * @param string|null                    $context          The listener context
      */
     public function registerListener($key, $logoutPath, $csrfTokenId, $csrfParameter, CsrfTokenManagerInterface $csrfTokenManager = null/*, string $context = null*/)
     {
diff --git a/RememberMe/AbstractRememberMeServices.php b/RememberMe/AbstractRememberMeServices.php
@@ -44,10 +44,8 @@ abstract class AbstractRememberMeServices implements RememberMeServicesInterface
     private $userProviders;
 
     /**
-     * @param array           $userProviders
      * @param string          $secret
      * @param string          $providerKey
-     * @param array           $options
      * @param LoggerInterface $logger
      *
      * @throws \InvalidArgumentException
diff --git a/Util/TargetPathTrait.php b/Util/TargetPathTrait.php
@@ -23,9 +23,8 @@ trait TargetPathTrait
      *
      * Usually, you do not need to set this directly.
      *
-     * @param SessionInterface $session
-     * @param string           $providerKey The name of your firewall
-     * @param string           $uri         The URI to set as the target path
+     * @param string $providerKey The name of your firewall
+     * @param string $uri         The URI to set as the target path
      */
     private function saveTargetPath(SessionInterface $session, $providerKey, $uri)
     {
@@ -35,8 +34,7 @@ private function saveTargetPath(SessionInterface $session, $providerKey, $uri)
     /**
      * Returns the URL (if any) the user visited that forced them to login.
      *
-     * @param SessionInterface $session
-     * @param string           $providerKey The name of your firewall
+     * @param string $providerKey The name of your firewall
      *
      * @return string|null
      */
@@ -48,8 +46,7 @@ private function getTargetPath(SessionInterface $session, $providerKey)
     /**
      * Removes the target path from the session.
      *
-     * @param SessionInterface $session
-     * @param string           $providerKey The name of your firewall
+     * @param string $providerKey The name of your firewall
      */
     private function removeTargetPath(SessionInterface $session, $providerKey)
     {

Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,7 @@ class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandle`
`40`	`40`	`];`
`41`	`41`
`42`	`42`	`/**`
`43`		`- * @param HttpUtils $httpUtils`
`44`		`- * @param array $options Options for processing a successful authentication attempt`
	`43`	`+ * @param array $options Options for processing a successful authentication attempt`
`45`	`44`	`*/`
`46`	`45`	`public function __construct(HttpUtils $httpUtils, array $options = [])`
`47`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,7 @@ class DefaultLogoutSuccessHandler implements LogoutSuccessHandlerInterface`
`26`	`26`	`protected $targetUrl;`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * @param HttpUtils $httpUtils`
`30`		`- * @param string $targetUrl`
	`29`	`+ * @param string $targetUrl`
`31`	`30`	`*/`
`32`	`31`	`public function __construct(HttpUtils $httpUtils, $targetUrl = '/')`
`33`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,6 @@ public function __construct(RequestStack $requestStack = null, UrlGeneratorInter`
`46`	`46`	`* @param string $csrfTokenId The ID of the CSRF token`
`47`	`47`	`* @param string $csrfParameter The CSRF token parameter name`
`48`	`48`	`* @param CsrfTokenManagerInterface\|null $csrfTokenManager A CsrfTokenManagerInterface instance`
`49`		`- * @param string\|null $context The listener context`
`50`	`49`	`*/`
`51`	`50`	`public function registerListener($key, $logoutPath, $csrfTokenId, $csrfParameter, CsrfTokenManagerInterface $csrfTokenManager = null/, string $context = null/)`
`52`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,8 @@ trait TargetPathTrait`
`23`	`23`	`*`
`24`	`24`	`* Usually, you do not need to set this directly.`
`25`	`25`	`*`
`26`		`- * @param SessionInterface $session`
`27`		`- * @param string $providerKey The name of your firewall`
`28`		`- * @param string $uri The URI to set as the target path`
	`26`	`+ * @param string $providerKey The name of your firewall`
	`27`	`+ * @param string $uri The URI to set as the target path`
`29`	`28`	`*/`
`30`	`29`	`private function saveTargetPath(SessionInterface $session, $providerKey, $uri)`
`31`	`30`	`{`
`@@ -35,8 +34,7 @@ private function saveTargetPath(SessionInterface $session, $providerKey, $uri)`
`35`	`34`	`/**`
`36`	`35`	`* Returns the URL (if any) the user visited that forced them to login.`
`37`	`36`	`*`
`38`		`- * @param SessionInterface $session`
`39`		`- * @param string $providerKey The name of your firewall`
	`37`	`+ * @param string $providerKey The name of your firewall`
`40`	`38`	`*`
`41`	`39`	`* @return string\|null`
`42`	`40`	`*/`
`@@ -48,8 +46,7 @@ private function getTargetPath(SessionInterface $session, $providerKey)`
`48`	`46`	`/**`
`49`	`47`	`* Removes the target path from the session.`
`50`	`48`	`*`
`51`		`- * @param SessionInterface $session`
`52`		`- * @param string $providerKey The name of your firewall`
	`49`	`+ * @param string $providerKey The name of your firewall`
`53`	`50`	`*/`
`54`	`51`	`private function removeTargetPath(SessionInterface $session, $providerKey)`
`55`	`52`	`{`