ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2024-12-16 10:18:55 +05:30
Code Issues Packages Projects Releases Wiki Activity

Updated docblocks and example queries in scope and client storage interfaces

Browse Source
This commit is contained in:
Alex Bilbie 2013-05-08 18:16:24 -07:00
parent 75894fd5bc
commit ca9760cd36
2 changed files with 45 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
src/League/OAuth2/Server/Storage/ClientInterface.php
View File

@ -13,43 +13,45 @@ namespace League\OAuth2\Server\Storage;
interface ClientInterface interface ClientInterface
{ {
/** /**
* Validate a client * Validate a client
* *
* Example SQL query: * Example SQL query:
* *
* <code> * <code>
* # Client ID + redirect URI * # Client ID + redirect URI
* SELECT oauth_clients.id FROM oauth_clients LEFT JOIN client_endpoints ON client_endpoints.client_id * SELECT oauth_clients.id, oauth_clients.secret, oauth_client_endpoints.redirect_uri, oauth_clients.name
* = oauth_clients.id WHERE oauth_clients.id = $clientId AND client_endpoints.redirect_uri = $redirectUri * FROM oauth_clients LEFT JOIN oauth_client_endpoints ON oauth_client_endpoints.client_id = oauth_clients.id
* * WHERE oauth_clients.id = :clientId AND oauth_client_endpoints.redirect_uri = :redirectUri
* # Client ID + client secret *
* SELECT oauth_clients.id FROM oauth_clients WHERE oauth_clients.id = $clientId AND * # Client ID + client secret
* oauth_clients.secret = $clientSecret * SELECT oauth_clients.id, oauth_clients.secret, oauth_clients.name FROM oauth_clients WHERE
* * oauth_clients.id = :clientId AND oauth_clients.secret = :clientSecret
* # Client ID + client secret + redirect URI *
* SELECT oauth_clients.id FROM oauth_clients LEFT JOIN client_endpoints ON client_endpoints.client_id * # Client ID + client secret + redirect URI
* = oauth_clients.id WHERE oauth_clients.id = $clientId AND oauth_clients.secret = $clientSecret * SELECT oauth_clients.id, oauth_clients.secret, oauth_client_endpoints.redirect_uri, oauth_clients.name FROM
* AND client_endpoints.redirect_uri = $redirectUri * oauth_clients LEFT JOIN oauth_client_endpoints ON oauth_client_endpoints.client_id = oauth_clients.id
* </code> * WHERE oauth_clients.id = :clientId AND oauth_clients.secret = :clientSecret AND
* * oauth_client_endpoints.redirect_uri = :redirectUri
* Response: * </code>
* *
* <code> * Response:
* Array *
* ( * <code>
* [client_id] => (string) The client ID * Array
* [client secret] => (string) The client secret * (
* [redirect_uri] => (string) The redirect URI used in this request * [client_id] => (string) The client ID
* [name] => (string) The name of the client * [client secret] => (string) The client secret
* ) * [redirect_uri] => (string) The redirect URI used in this request
* </code> * [name] => (string) The name of the client
* * )
* @param string $clientId The client's ID * </code>
* @param string $clientSecret The client's secret (default = "null") *
* @param string $redirectUri The client's redirect URI (default = "null") * @param string $clientId The client's ID
* @param string $grantType The grant type used in the request * @param string $clientSecret The client's secret (default = "null")
* @return bool|array Returns false if the validation fails, array on success * @param string $redirectUri The client's redirect URI (default = "null")
*/ * @param string $grantType The grant type used in the request
* @return bool|array Returns false if the validation fails, array on success
*/
public function getClient($clientId = null, $clientSecret = null, $redirectUri = null, $grantType = null); public function getClient($clientId = null, $clientSecret = null, $redirectUri = null, $grantType = null);
} }

9
src/League/OAuth2/Server/Storage/ScopeInterface.php
View File

@ -19,7 +19,7 @@ interface ScopeInterface
* Example SQL query: * Example SQL query:
* *
* <code> * <code>
* SELECT * FROM oauth_scopes WHERE scope = $scope * SELECT * FROM oauth_scopes WHERE oauth_scopes.key = :scope
* </code> * </code>
* *
* Response: * Response:
@ -28,14 +28,15 @@ interface ScopeInterface
* Array * Array
* ( * (
* [id] => (int) The scope's ID * [id] => (int) The scope's ID
* [scope] => (string) The scope itself * [key] => (string) The scope itself
* [name] => (string) The scope's name * [name] => (string) The scope's name
* [description] => (string) The scope's description * [description] => (string) The scope's description
* ) * )
* </code> * </code>
* *
* @param string $scope The scope * @param string $scope The scope
* @param string $clientId The client ID * @param string $clientId The client ID
* @param string $grantType The grant type used in the request
* @return bool|array If the scope doesn't exist return false * @return bool|array If the scope doesn't exist return false
*/ */
public function getScope($scope, $clientId = null, $grantType = null); public function getScope($scope, $clientId = null, $grantType = null);