ILIAS\LTI\ToolProvider\AccessToken Class Reference

Class to represent an HTTP message. More...

Collaboration diagram for ILIAS\LTI\ToolProvider\AccessToken:

Public Member Functions
	__construct (Platform $platform, array $scopes=null, string $token=null, int $expires=null)
	Class constructor. More...
	getPlatform ()
	Get platform. More...
	load ()
	Load a nonce value from the database. More...
	save ()
	Save a nonce value in the database. More...
	hasScope (string $scope='')
	Check if a valid access token exists for a specific scope (or any scope if none specified). More...
	get (string $scope='', bool $scopeOnly=false)
	Obtain a valid access token for a scope. More...

Data Fields
string	$token = null
	Access token string. More...
int	$expires = null
	Timestamp at which the token string expires. More...
array	$scopes = array()
	Scope(s) for which the access token is valid. More...
int	$created = null
	Timestamp for when the object was created. More...
int	$updated = null
	Timestamp for when the object was last updated. More...

Private Attributes
Platform	$platform = null
	Platform for this context. More...

Detailed Description

Class to represent an HTTP message.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Version

3.0.0 http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 32 of file AccessToken.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LTI\ToolProvider\AccessToken::__construct	(	Platform	$platform,
		array	$scopes = null,
		string	$token = null,
		int	$expires = null
	)

Class constructor.

Parameters

Platform	$platform	Platform
array | null	$scopes	Scopes for which the access token is valid
string | null	$token	Access token string
int | null	$expires	Time in seconds after which the token string will expire //UK: changed datetime to int

Definition at line 83 of file AccessToken.php.

References ILIAS\LTI\ToolProvider\AccessToken\$expires, ILIAS\LTI\ToolProvider\AccessToken\$platform, ILIAS\LTI\ToolProvider\AccessToken\$scopes, ILIAS\LTI\ToolProvider\AccessToken\$token, and ILIAS\LTI\ToolProvider\AccessToken\load().

    {
        $this->platform = $platform;
        $this->scopes = $scopes;
        if (!empty($token)) {
            $this->token = $token;
        }
        if (!empty($expires)) {
            $this->expires = time() + $expires;
        }
        $this->created = null;
        $this->updated = null;
        if (empty($scopes)) {
            $this->load();
        }
    }

Here is the call graph for this function:

Member Function Documentation

get()

ILIAS\LTI\ToolProvider\AccessToken::get	(	string	$scope = '',
		bool	$scopeOnly = false
	)

Obtain a valid access token for a scope.

Parameters

string	$scope	Access scope
bool	$scopeOnly	If true, a token is requested just for the specified scope

Returns

AccessToken New access token

Definition at line 153 of file AccessToken.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, $http, ILIAS\LTI\ToolProvider\AccessToken\$platform, $scope, $type, $url, and ILIAS\LTI\ToolProvider\AccessToken\save().

                                                                    : AccessToken
    {
        $url = $this->platform->accessTokenUrl;
        if (!empty($url) && !empty(Tool::$defaultTool) && !empty(Tool::$defaultTool->rsaKey)) {
            if ($scopeOnly) {
                $scopesRequested = array($scope);
            } else {
                $scopesRequested = Tool::$defaultTool->requiredScopes;
                if (substr($scope, -9) === '.readonly') {
                    $scope2 = substr($scope, 0, -9);
                } else {
                    $scope2 = $scope;
                }
                if (!empty($scope) && !in_array($scope, $scopesRequested) && !in_array($scope2, $scopesRequested)) {
                    $scopesRequested[] = $scope;
                }
            }
            if (!empty($scopesRequested)) {
                $retry = false;
                do {
                    $method = 'POST';
                    $type = 'application/x-www-form-urlencoded';
                    $body = array(
                        'grant_type' => 'client_credentials',
                        'client_assertion_type' => 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
                        'scope' => implode(' ', $scopesRequested)
                    );
                    if (!empty(Tool::$defaultTool)) {
                        Tool::$defaultTool->platform = $this->platform;
                        $body = Tool::$defaultTool->signServiceRequest($url, $method, $type, $body);
                    } else {
                        $body = $this->platform->signServiceRequest($url, $method, $type, $body);
                    }
                    $http = new HttpMessage($url, $method, $body);
                    if ($http->send() && !empty($http->response)) {
                        $http->responseJson = json_decode($http->response);
                        if (!is_null($http->responseJson) && !empty($http->responseJson->access_token) && !empty($http->responseJson->expires_in)) {
                            if (isset($http->responseJson->scope)) {
                                $scopesAccepted = explode(' ', $http->responseJson->scope);
                            } else {
                                $scopesAccepted = $scopesRequested;
                            }
                            $this->scopes = $scopesAccepted;
                            $this->token = $http->responseJson->access_token;
                            $this->expires = time() + $http->responseJson->expires_in;
                            if (!$scopeOnly) {
                                $this->save();
                            }
                        }
                        $retry = false;
                    } elseif ($retry) {
                        $retry = false;
                    } elseif (!empty($scope) && (count($scopesRequested) > 1)) {  // Just ask for the single scope requested
                        $retry = true;
                        $scopesRequested = array($scope);
                    }
                } while ($retry);
            }
        } else {
            $this->scopes = null;
            $this->token = null;
            $this->expires = null;
            $this->created = null;
            $this->updated = null;
        }

        return $this;
    }

Here is the call graph for this function:

getPlatform()

ILIAS\LTI\ToolProvider\AccessToken::getPlatform

(

)

Get platform.

Returns

Platform Platform object for this resource link.

Definition at line 105 of file AccessToken.php.

References ILIAS\LTI\ToolProvider\AccessToken\$platform.

                                 : ?Platform
    {
        return $this->platform;
    }

hasScope()

ILIAS\LTI\ToolProvider\AccessToken::hasScope

(

string

$scope = ''

)

Check if a valid access token exists for a specific scope (or any scope if none specified).

Parameters

string

$scope

Access scope

Returns

bool True if there is an unexpired access token for specified scope

Definition at line 136 of file AccessToken.php.

References $scope.

                                                : bool
    {
        if (substr($scope, -9) === '.readonly') {
            $scope2 = substr($scope, 0, -9);
        } else {
            $scope2 = $scope;
        }
        return !empty($this->token) && (empty($this->expires) || ($this->expires > time())) &&
            (empty($scope) || empty($this->scopes) || (in_array($scope, $this->scopes) || in_array($scope2, $this->scopes)));
    }

load()

ILIAS\LTI\ToolProvider\AccessToken::load

(

)

Load a nonce value from the database.

Returns

bool True if the nonce value was successfully loaded

Definition at line 115 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\__construct().

                          : bool
    {
        return $this->platform->getDataConnector()->loadAccessToken($this);
    }

Here is the caller graph for this function:

save()

ILIAS\LTI\ToolProvider\AccessToken::save

(

)

Save a nonce value in the database.

Returns

bool True if the nonce value was successfully saved

Definition at line 125 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\get().

                          : bool
    {
        sort($this->scopes);
        return $this->platform->getDataConnector()->saveAccessToken($this);
    }

Here is the caller graph for this function:

Field Documentation

$created

int null ILIAS\LTI\ToolProvider\AccessToken::$created = null

Timestamp for when the object was created.

Definition at line 67 of file AccessToken.php.

$expires

int null ILIAS\LTI\ToolProvider\AccessToken::$expires = null

Timestamp at which the token string expires.

Definition at line 46 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\__construct().

$platform

Platform null ILIAS\LTI\ToolProvider\AccessToken::$platform = null

private

Platform for this context.

Definition at line 60 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\__construct(), ILIAS\LTI\ToolProvider\AccessToken\get(), and ILIAS\LTI\ToolProvider\AccessToken\getPlatform().

$scopes

array ILIAS\LTI\ToolProvider\AccessToken::$scopes = array()

Scope(s) for which the access token is valid.

Definition at line 53 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\__construct().

$token

string null ILIAS\LTI\ToolProvider\AccessToken::$token = null

Access token string.

Definition at line 39 of file AccessToken.php.

Referenced by ILIAS\LTI\ToolProvider\AccessToken\__construct().

$updated

int null ILIAS\LTI\ToolProvider\AccessToken::$updated = null

Timestamp for when the object was last updated.

Definition at line 74 of file AccessToken.php.

---

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

• Services/LTI/src/ToolProvider/AccessToken.php