Updating interface method per suggestion - makes sense to me, Request is redundant

weaverryan · weaverryan · commit eb158cbdb352 · 2015-09-20T19:24:21.000-04:00
diff --git a/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php b/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php
@@ -74,11 +74,11 @@ private function executeGuardAuthenticator($uniqueGuardKey, GuardAuthenticatorIn
         $request = $event->getRequest();
         try {
             if (null !== $this->logger) {
-                $this->logger->info('Calling getCredentialsFromRequest on guard configurator', array('firewall_key' => $this->providerKey, 'authenticator' => get_class($guardAuthenticator)));
+                $this->logger->info('Calling getCredentials on guard configurator.', array('firewall_key' => $this->providerKey, 'authenticator' => get_class($guardAuthenticator)));
             }
 
             // allow the authenticator to fetch authentication info from the request
-            $credentials = $guardAuthenticator->getCredentialsFromRequest($request);
+            $credentials = $guardAuthenticator->getCredentials($request);
 
             // allow null to be returned to skip authentication
             if (null === $credentials) {
diff --git a/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php b/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php
@@ -44,13 +44,13 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
      *
      * @return mixed|null
      */
-    public function getCredentialsFromRequest(Request $request);
+    public function getCredentials(Request $request);
 
     /**
      * Return a UserInterface object based on the credentials OR throw
      * an AuthenticationException.
      *
-     * The *credentials* are the return value from getCredentialsFromRequest()
+     * The *credentials* are the return value from getCredentials()
      *
      * @param mixed                 $credentials
      * @param UserProviderInterface $userProvider
diff --git a/src/Symfony/Component/Security/Guard/Tests/Firewall/GuardAuthenticationListenerTest.php b/src/Symfony/Component/Security/Guard/Tests/Firewall/GuardAuthenticationListenerTest.php
@@ -38,7 +38,7 @@ public function testHandleSuccess()
         $credentials = array('username' => 'weaverryan', 'password' => 'all_your_base');
         $authenticator
             ->expects($this->once())
-            ->method('getCredentialsFromRequest')
+            ->method('getCredentials')
             ->with($this->equalTo($this->request))
             ->will($this->returnValue($credentials));
 
@@ -87,7 +87,7 @@ public function testHandleSuccessWithRememberMe()
 
         $authenticator
             ->expects($this->once())
-            ->method('getCredentialsFromRequest')
+            ->method('getCredentials')
             ->with($this->equalTo($this->request))
             ->will($this->returnValue(array('username' => 'anything_not_empty')));
 
@@ -130,7 +130,7 @@ public function testHandleCatchesAuthenticationException()
         $authException = new AuthenticationException('Get outta here crazy user with a bad password!');
         $authenticator
             ->expects($this->once())
-            ->method('getCredentialsFromRequest')
+            ->method('getCredentials')
             ->will($this->throwException($authException));
 
         // this is not called
@@ -162,11 +162,11 @@ public function testReturnNullToSkipAuth()
 
         $authenticatorA
             ->expects($this->once())
-            ->method('getCredentialsFromRequest')
+            ->method('getCredentials')
             ->will($this->returnValue(null));
         $authenticatorB
             ->expects($this->once())
-            ->method('getCredentialsFromRequest')
+            ->method('getCredentials')
             ->will($this->returnValue(null));
 
         // this is not called

Original file line number	Diff line number	Diff line change
`@@ -44,13 +44,13 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface`
`44`	`44`	`*`
`45`	`45`	`* @return mixed\|null`
`46`	`46`	`*/`
`47`		`- public function getCredentialsFromRequest(Request $request);`
	`47`	`+ public function getCredentials(Request $request);`
`48`	`48`
`49`	`49`	`/**`
`50`	`50`	`* Return a UserInterface object based on the credentials OR throw`
`51`	`51`	`* an AuthenticationException.`
`52`	`52`	`*`
`53`		`- * The credentials are the return value from getCredentialsFromRequest()`
	`53`	`+ * The credentials are the return value from getCredentials()`
`54`	`54`	`*`
`55`	`55`	`* @param mixed $credentials`
`56`	`56`	`* @param UserProviderInterface $userProvider`