ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2024-11-02 00:43:11 +05:30
Code Issues Packages Projects Releases Wiki Activity

Renamed functions, changed some doc terms

Browse Source
This commit is contained in:
Alex Bilbie 2013-01-29 16:21:21 +00:00
parent 14b680f6be
commit ffcad85d95
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/OAuth2/Storage/SessionInterface.php
View File

@ -7,7 +7,7 @@ interface SessionInterface
/** /**
* Create a new OAuth session * Create a new OAuth session
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* INSERT INTO oauth_sessions (client_id, redirect_uri, owner_type, * INSERT INTO oauth_sessions (client_id, redirect_uri, owner_type,
@ -26,7 +26,7 @@ interface SessionInterface
* @param string $stage The stage of the session (default ="request") * @param string $stage The stage of the session (default ="request")
* @return int The session ID * @return int The session ID
*/ */
public function new( public function create(
$clientId, $clientId,
$redirectUri, $redirectUri,
$type = 'user', $type = 'user',
@ -41,7 +41,7 @@ interface SessionInterface
/** /**
* Update an OAuth session * Update an OAuth session
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* UPDATE oauth_sessions SET auth_code = $authCode, access_token = * UPDATE oauth_sessions SET auth_code = $authCode, access_token =
@ -87,7 +87,7 @@ interface SessionInterface
/** /**
* Return the session ID for a given session owner and client combination * Return the session ID for a given session owner and client combination
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* SELECT id FROM oauth_sessions WHERE client_id = $clientId * SELECT id FROM oauth_sessions WHERE client_id = $clientId
@ -109,7 +109,7 @@ interface SessionInterface
/** /**
* Validate that an authorisation code is valid * Validate that an authorisation code is valid
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* SELECT id FROM oauth_sessions WHERE client_id = $clientID AND * SELECT id FROM oauth_sessions WHERE client_id = $clientID AND
@ -150,7 +150,7 @@ interface SessionInterface
/** /**
* Removes an authorisation code associated with a session * Removes an authorisation code associated with a session
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* UPDATE oauth_sessions SET auth_code = NULL WHERE id = $sessionId * UPDATE oauth_sessions SET auth_code = NULL WHERE id = $sessionId
@ -164,7 +164,7 @@ interface SessionInterface
/** /**
* Sets a sessions access token * Sets a sessions access token
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* UPDATE oauth_sessions SET access_token = $accessToken WHERE id = * UPDATE oauth_sessions SET access_token = $accessToken WHERE id =
@ -185,7 +185,7 @@ interface SessionInterface
/** /**
* Return the access token for a given session * Return the access token for a given session
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* SELECT access_token FROM oauth_sessions WHERE id = $sessionId * SELECT access_token FROM oauth_sessions WHERE id = $sessionId
@ -202,7 +202,7 @@ interface SessionInterface
/** /**
* Update the refresh token * Update the refresh token
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* UPDATE oauth_sessions SET access_token = $newAccessToken, refresh_token = * UPDATE oauth_sessions SET access_token = $newAccessToken, refresh_token =
@ -221,26 +221,23 @@ interface SessionInterface
/** /**
* Associates a session with a scope * Associates a session with a scope
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* INSERT INTO oauth_session_scopes (session_id, scope) VALUE ($sessionId, * INSERT INTO oauth_session_scopes (session_id, scope_id) VALUE ($sessionId,
* $scope) * $scopeId)
* </code> * </code>
* *
* @param int $sessionId The session ID * @param int $sessionId The session ID
* @param string $scope The scope * @param string $scope The scope ID
* @return void * @return void
*/ */
public function associateScope( public function associateScope($sessionId, $scopeId);
$sessionId,
$scope
);
/** /**
* Return the scopes associated with an access token * Return the scopes associated with an access token
* *
* Database query: * Example SQL query:
* *
* <code> * <code>
* SELECT scopes.scope, scopes.name, scopes.description FROM * SELECT scopes.scope, scopes.name, scopes.description FROM