Inheritance diagram for OAuth2\Storage\ClientCredentialsInterface:
Public Member Functions | |
| checkClientCredentials ($client_id, $client_secret=null) | |
| isPublicClient ($client_id) | |
 Public Member Functions inherited from OAuth2\Storage\ClientInterface | |
| getClientDetails ($client_id) | |
| getClientScope ($client_id) | |
| checkRestrictedGrantType ($client_id, $grant_type) | |
Detailed Description
Implement this interface to specify how the OAuth2 Server should verify client credentials
Definition at line 11 of file ClientCredentialsInterface.php.
Member Function Documentation
◆ checkClientCredentials()
| OAuth2\Storage\ClientCredentialsInterface::checkClientCredentials | ( | $client_id, | |
$client_secret = null |
|||
| ) |
Make sure that the client credentials is valid.
- Parameters
-
$client_id Client identifier to be check with. $client_secret (optional) If a secret is required, check that they've given the right one.
- Returns
- TRUE if the client credentials are valid, and MUST return FALSE if it isn't.
Implemented in OAuth2\Storage\Redis, OAuth2\Storage\Pdo, OAuth2\Storage\Mongo, OAuth2\Storage\Memory, OAuth2\Storage\DynamoDB, OAuth2\Storage\CouchbaseDB, and OAuth2\Storage\Cassandra.
◆ isPublicClient()
| OAuth2\Storage\ClientCredentialsInterface::isPublicClient | ( | $client_id | ) |
Determine if the client is a "public" client, and therefore does not require passing credentials for certain grant types
- Parameters
-
$client_id Client identifier to be check with.
- Returns
- TRUE if the client is public, and FALSE if it isn't.
- See also
- http://tools.ietf.org/html/rfc6749#section-2.3
- https://github.com/bshaffer/oauth2-server-php/issues/257
Implemented in OAuth2\Storage\Redis, OAuth2\Storage\Pdo, OAuth2\Storage\Mongo, OAuth2\Storage\Memory, OAuth2\Storage\DynamoDB, OAuth2\Storage\CouchbaseDB, and OAuth2\Storage\Cassandra.
The documentation for this interface was generated from the following file:
- plugins/OAuth2/Storage/ClientCredentialsInterface.php
