Campustream 1.0
A social network MQP for WPI
OAuth2 Class Reference

Public Member Functions

 __construct ($access_token_lifetime=3600, $auth_code_lifetime=30, $refresh_token_lifetime=1209600)
 verify_access_token ($scope=null, $exit_not_present=true, $exit_invalid=true, $exit_expired=true, $exit_scope=true, $realm=null)
 grant_access_token ()
 get_authorize_params ()
 finish_client_authorization ($is_authorized, $type, $client_id, $redirect_uri, $state, $scope=null)
 error ($code, $message=null, $description=null)
 callback_error ($redirect_uri, $error, $state, $message=null, $error_uri=null)

Protected Member Functions

 auth_client_credentials ($client_id, $client_secret=null)
 get_redirect_uri ($client_id)
 get_access_token ($token_id)
 store_access_token ($token_id, $client_id, $expires, $scope=null)
 get_supported_grant_types ()
 get_supported_auth_response_types ()
 get_supported_scopes ()
 authorize_client_response_type ($client_id, $response_type)
 authorize_client ($client_id, $grant_type)
 get_stored_auth_code ($code)
 store_auth_code ($code, $client_id, $redirect_uri, $expires, $scope)
 check_user_credentials ($client_id, $username, $password)
 check_assertion ($client_id, $assertion_type, $assertion)
 get_refresh_token ($refresh_token)
 store_refresh_token ($token, $client_id, $expires, $scope=null)
 expire_refresh_token ($token)
 check_none_access ($client_id)
 get_default_authentication_realm ()
 get_client_credentials ()
 create_access_token ($client_id, $scope)
 gen_access_token ()
 gen_auth_code ()

Detailed Description

Definition at line 77 of file oauth2.php.


Constructor & Destructor Documentation

__construct ( access_token_lifetime = 3600,
auth_code_lifetime = 30,
refresh_token_lifetime = 1209600 
)

Definition at line 304 of file oauth2.php.


Member Function Documentation

auth_client_credentials ( client_id,
client_secret = null 
) [abstract, protected]
authorize_client ( client_id,
grant_type 
) [protected]

Definition at line 162 of file oauth2.php.

authorize_client_response_type ( client_id,
response_type 
) [protected]

Definition at line 156 of file oauth2.php.

callback_error ( redirect_uri,
error,
state,
message = null,
error_uri = null 
)

Definition at line 745 of file oauth2.php.

check_assertion ( client_id,
assertion_type,
assertion 
) [protected]

Definition at line 224 of file oauth2.php.

check_none_access ( client_id) [protected]

Definition at line 289 of file oauth2.php.

check_user_credentials ( client_id,
username,
password 
) [protected]

Definition at line 200 of file oauth2.php.

create_access_token ( client_id,
scope 
) [protected]

Definition at line 672 of file oauth2.php.

error ( code,
message = null,
description = null 
)

Definition at line 731 of file oauth2.php.

expire_refresh_token ( token) [protected]

Definition at line 278 of file oauth2.php.

finish_client_authorization ( is_authorized,
type,
client_id,
redirect_uri,
state,
scope = null 
)

Definition at line 624 of file oauth2.php.

gen_access_token ( ) [protected]

Definition at line 701 of file oauth2.php.

gen_auth_code ( ) [protected]

Definition at line 705 of file oauth2.php.

get_access_token ( token_id) [abstract, protected]
get_authorize_params ( )

Definition at line 561 of file oauth2.php.

get_client_credentials ( ) [protected]

Definition at line 536 of file oauth2.php.

get_default_authentication_realm ( ) [protected]

Definition at line 293 of file oauth2.php.

get_redirect_uri ( client_id) [abstract, protected]
get_refresh_token ( refresh_token) [protected]

Definition at line 248 of file oauth2.php.

get_stored_auth_code ( code) [protected]

Definition at line 171 of file oauth2.php.

get_supported_auth_response_types ( ) [protected]

Definition at line 136 of file oauth2.php.

get_supported_grant_types ( ) [protected]

Definition at line 122 of file oauth2.php.

get_supported_scopes ( ) [protected]

Definition at line 146 of file oauth2.php.

grant_access_token ( )

Definition at line 431 of file oauth2.php.

store_access_token ( token_id,
client_id,
expires,
scope = null 
) [abstract, protected]
store_auth_code ( code,
client_id,
redirect_uri,
expires,
scope 
) [protected]

Definition at line 189 of file oauth2.php.

store_refresh_token ( token,
client_id,
expires,
scope = null 
) [protected]

Definition at line 265 of file oauth2.php.

verify_access_token ( scope = null,
exit_not_present = true,
exit_invalid = true,
exit_expired = true,
exit_scope = true,
realm = null 
)

Definition at line 332 of file oauth2.php.


The documentation for this class was generated from the following file: