Authenticator class example - fixing comment

thtroyer · thtroyer · commit df4266e0ac34 · 2016-11-09T00:03:57.000Z
diff --git a/security/guard_authentication.rst b/security/guard_authentication.rst
@@ -165,14 +165,14 @@ This requires you to implement six methods::
     {
         /**
          * Called on every request. Return whatever credentials you want to
-         * be passed to getUser().  Returning null will cause authentication
-         * to be successful, skipping the rest of the authentication process.
+         * be passed to getUser().  Returning null will cause this authenticator
+         * to be skipped.
          */
         public function getCredentials(Request $request)
         {
             if (!$token = $request->headers->get('X-AUTH-TOKEN')) {
-                // No token?
-                $token = null;
+                // No token? 
+                $token = '';
             }
 
             // What you return here will be passed to getUser() as $credentials

Original file line number	Diff line number	Diff line change
`@@ -165,14 +165,14 @@ This requires you to implement six methods::`
`165`	`165`	`{`
`166`	`166`	`/**`
`167`	`167`	`* Called on every request. Return whatever credentials you want to`
`168`		`- * be passed to getUser(). Returning null will cause authentication`
`169`		`- * to be successful, skipping the rest of the authentication process.`
	`168`	`+ * be passed to getUser(). Returning null will cause this authenticator`
	`169`	`+ * to be skipped.`
`170`	`170`	`*/`
`171`	`171`	`public function getCredentials(Request $request)`
`172`	`172`	`{`
`173`	`173`	`if (!$token = $request->headers->get('X-AUTH-TOKEN')) {`
`174`		`- // No token?`
`175`		`- $token = null;`
	`174`	`+ // No token?`
	`175`	`+ $token = '';`
`176`	`176`	`}`
`177`	`177`
`178`	`178`	`// What you return here will be passed to getUser() as $credentials`