[Security] [Guard] Added type-hints to AuthenticatorInterface

thomasbisignani · thomasbisignani · commit 51b3c2e84eae · 2019-07-02T20:55:49.000+02:00
diff --git a/src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php b/src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php
@@ -25,11 +25,9 @@ abstract class AbstractGuardAuthenticator implements AuthenticatorInterface
      * Shortcut to create a PostAuthenticationGuardToken for you, if you don't really
      * care about which authenticated token you're using.
      *
-     * @param string $providerKey
-     *
      * @return PostAuthenticationGuardToken
      */
-    public function createAuthenticatedToken(UserInterface $user, $providerKey)
+    public function createAuthenticatedToken(UserInterface $user, string $providerKey)
     {
         return new PostAuthenticationGuardToken(
             $user,
diff --git a/src/Symfony/Component/Security/Guard/AuthenticatorInterface.php b/src/Symfony/Component/Security/Guard/AuthenticatorInterface.php
@@ -108,12 +108,9 @@ public function checkCredentials($credentials, UserInterface $user);
      *
      * @see AbstractGuardAuthenticator
      *
-     * @param UserInterface $user
-     * @param string        $providerKey The provider (i.e. firewall) key
-     *
      * @return GuardTokenInterface
      */
-    public function createAuthenticatedToken(UserInterface $user, $providerKey);
+    public function createAuthenticatedToken(UserInterface $user, string $providerKey);
 
     /**
      * Called when authentication executed, but failed (e.g. wrong username password).
@@ -140,13 +137,9 @@ 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
-     *
      * @return Response|null
      */
-    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey);
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $providerKey);
 
     /**
      * Does this method support remember me cookies?
diff --git a/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php b/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php
@@ -103,7 +103,7 @@ public function supports(Request $request)
         return true;
     }
 
-    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $providerKey)
     {
     }
 

Original file line number	Diff line number	Diff line change
`@@ -25,11 +25,9 @@ abstract class AbstractGuardAuthenticator implements AuthenticatorInterface`
`25`	`25`	`* Shortcut to create a PostAuthenticationGuardToken for you, if you don't really`
`26`	`26`	`* care about which authenticated token you're using.`
`27`	`27`	`*`
`28`		`- * @param string $providerKey`
`29`		`- *`
`30`	`28`	`* @return PostAuthenticationGuardToken`
`31`	`29`	`*/`
`32`		`- public function createAuthenticatedToken(UserInterface $user, $providerKey)`
	`30`	`+ public function createAuthenticatedToken(UserInterface $user, string $providerKey)`
`33`	`31`	`{`
`34`	`32`	`return new PostAuthenticationGuardToken(`
`35`	`33`	`$user,`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ public function supports(Request $request)`
`103`	`103`	`return true;`
`104`	`104`	`}`
`105`	`105`
`106`		`- public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)`
	`106`	`+ public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $providerKey)`
`107`	`107`	`{`
`108`	`108`	`}`
`109`	`109`