ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2025-03-06 16:29:18 +05:30
Code Issues Packages Projects Releases Wiki Activity

Lots of small documentation updates and clarifications

Browse Source
This commit is contained in:
Alex Bilbie 2012-11-20 15:27:33 +00:00
parent fead044830
commit 958eab33a7
1 changed files with 75 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/Oauth2/Authentication/Database.php
View File

@ -26,10 +26,22 @@ interface Database
* $redirectUri * $redirectUri
* </code> * </code>
* *
* @param string $clientId The client's ID * Response:
*
* <code>
* Array
* (
* [client_id] => (string) The client ID
* [client secret] => (string) The client secret
* [redirect_uri] => (string) The redirect URI used in this request
* [name] => (string) The name of the client
* )
* </code>
*
* @param string $clientId The client's ID
* @param string $clientSecret The client's secret (default = "null") * @param string $clientSecret The client's secret (default = "null")
* @param string $redirectUri The client's redirect URI (default = "null") * @param string $redirectUri The client's redirect URI (default = "null")
* @return [type] [description] * @return bool|array Returns false if the validation fails, array on success
*/ */
public function validateClient( public function validateClient(
$clientId, $clientId,
@ -56,7 +68,7 @@ interface Database
* @param string $authCode The authorisation code (default = "null") * @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null") * @param string $accessToken The access token (default = "null")
* @param string $stage The stage of the session (default ="request") * @param string $stage The stage of the session (default ="request")
* @return [type] [description] * @return int The session ID
*/ */
public function newSession( public function newSession(
$clientId, $clientId,
@ -84,7 +96,7 @@ interface Database
* @param string $authCode The authorisation code (default = "null") * @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null") * @param string $accessToken The access token (default = "null")
* @param string $stage The stage of the session (default ="request") * @param string $stage The stage of the session (default ="request")
* @return void * @return void
*/ */
public function updateSession( public function updateSession(
$sessionId, $sessionId,
@ -105,7 +117,7 @@ interface Database
* @param string $clientId The client ID * @param string $clientId The client ID
* @param string $type The session owner's type * @param string $type The session owner's type
* @param string $typeId The session owner's ID * @param string $typeId The session owner's ID
* @return [type] [description] * @return void
*/ */
public function deleteSession( public function deleteSession(
$clientId, $clientId,
@ -145,7 +157,7 @@ interface Database
* @param string $clientId The client ID * @param string $clientId The client ID
* @param string $redirectUri The redirect URI * @param string $redirectUri The redirect URI
* @param string $authCode The authorisation code * @param string $authCode The authorisation code
* @return int|bool Returns the session ID if the auth code * @return int|bool Returns the session ID if the auth code
* is valid otherwise returns false * is valid otherwise returns false
*/ */
public function validateAuthCode( public function validateAuthCode(