Improve invalid user provider exception message

mvar · weaverryan · commit 8556ae2979ca · 2015-05-23T14:57:11.000-04:00
diff --git a/cookbook/security/api_key_authentication.rst b/cookbook/security/api_key_authentication.rst
@@ -58,7 +58,10 @@ value and then a User object is created::
         {
             if (!$userProvider instanceof ApiKeyUserProvider) {
                 throw new \InvalidArgumentException(
-                    '$userProvider must be an instance of "ApiKeyUserProvider".'
+                    sprintf(
+                        'The user provider must be an instance of ApiKeyUserProvider (%s was given).',
+                        get_class($userProvider)
+                    )
                 );
             }
 
@@ -507,7 +510,10 @@ to see if the stored token has a valid User object that can be used::
         {
             if (!$userProvider instanceof ApiKeyUserProvider) {
                 throw new \InvalidArgumentException(
-                    '$userProvider must be an instance of "ApiKeyUserProvider".'
+                    sprintf(
+                        'The user provider must be an instance of ApiKeyUserProvider (%s was given).',
+                        get_class($userProvider)
+                    )
                 );
             }
 

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,10 @@ value and then a User object is created::`
`58`	`58`	`{`
`59`	`59`	`if (!$userProvider instanceof ApiKeyUserProvider) {`
`60`	`60`	`throw new \InvalidArgumentException(`
`61`		`- '$userProvider must be an instance of "ApiKeyUserProvider".'`
	`61`	`+ sprintf(`
	`62`	`+ 'The user provider must be an instance of ApiKeyUserProvider (%s was given).',`
	`63`	`+ get_class($userProvider)`
	`64`	`+ )`
`62`	`65`	`);`
`63`	`66`	`}`
`64`	`67`
`@@ -507,7 +510,10 @@ to see if the stored token has a valid User object that can be used::`
`507`	`510`	`{`
`508`	`511`	`if (!$userProvider instanceof ApiKeyUserProvider) {`
`509`	`512`	`throw new \InvalidArgumentException(`
`510`		`- '$userProvider must be an instance of "ApiKeyUserProvider".'`
	`513`	`+ sprintf(`
	`514`	`+ 'The user provider must be an instance of ApiKeyUserProvider (%s was given).',`
	`515`	`+ get_class($userProvider)`
	`516`	`+ )`
`511`	`517`	`);`
`512`	`518`	`}`
`513`	`519`