LTI Integration Library 4.10.3
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
OAuthServer Class Reference

Class to represent an OAuth server. More...

Public Member Functions

 __construct ($data_store)
 Class constructor.
 
 add_signature_method ($signature_method)
 Add a signature method.
 
 fetch_request_token (&$request)
 Process a request_token request.
 
 fetch_access_token (&$request)
 Process an access_token request.
 
 verify_request (&$request)
 Verify an API call, checks all the parameters.
 

Protected Attributes

 $timestamp_threshold = 300
 Timestamp threshhold.
 
 $version = '1.0'
 Version string.
 
 $signature_methods = array()
 Signature methods.
 
 $data_store
 Data store.
 

Detailed Description

Class to represent an OAuth server.

Version
2008-08-04
Licence: https://opensource.org/licenses/MIT The MIT License

Definition at line 12 of file OAuthServer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $data_store)

Class constructor.

Parameters
OAuthDataStore$data_storeData store

Definition at line 48 of file OAuthServer.php.

References OAuthServer\$data_store.

Member Function Documentation

◆ add_signature_method()

add_signature_method (   $signature_method)

Add a signature method.

Parameters
OAuthSignatureMethod$signature_methodSignature method

Definition at line 58 of file OAuthServer.php.

◆ fetch_access_token()

fetch_access_token ( $request)

Process an access_token request.

Returns the access token on success

Parameters
OAuthRequest$requestRequest
Returns
OAuthToken|null

Definition at line 101 of file OAuthServer.php.

◆ fetch_request_token()

fetch_request_token ( $request)

Process a request_token request.

Returns the request token on success

Parameters
OAuthRequest$requestRequest
Returns
OAuthToken|null

Definition at line 74 of file OAuthServer.php.

◆ verify_request()

verify_request ( $request)

Verify an API call, checks all the parameters.

Parameters
OAuthRequest$requestRequest
Returns
array

Definition at line 126 of file OAuthServer.php.

Field Documentation

◆ $data_store

OAuthDataStore $data_store
protected

Data store.

Definition at line 41 of file OAuthServer.php.

Referenced by OAuthServer\__construct().

◆ $signature_methods

array $signature_methods = array()
protected

Signature methods.

Definition at line 34 of file OAuthServer.php.

◆ $timestamp_threshold

int $timestamp_threshold = 300
protected

Timestamp threshhold.

Definition at line 20 of file OAuthServer.php.

◆ $version

string $version = '1.0'
protected

Version string.

Definition at line 27 of file OAuthServer.php.


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