Class to represent a tool consumer. More...

Inheritance diagram for IMSGlobal\LTI\ToolProvider\ToolConsumer:

Collaboration diagram for IMSGlobal\LTI\ToolProvider\ToolConsumer:

Public Member Functions
	__construct ($key=null, $dataConnector=null, $autoEnable=false)
	Class constructor. More...

	initialize ()
	Initialise the tool consumer. More...

	initialise ()
	Initialise the tool consumer. More...

	save ()
	Save the tool consumer to the database. More...

	delete ()
	Delete the tool consumer from the database. More...

	getRecordId ()
	Get the tool consumer record ID. More...

	setRecordId ($id)
	Sets the tool consumer record ID. More...

	getKey ()
	Get the tool consumer key. More...

	setKey ($key)
	Set the tool consumer key. More...

	getDataConnector ()
	Get the data connector. More...

	getIsAvailable ()
	Is the consumer key available to accept launch requests? More...

	getSetting ($name, $default='')
	Get a setting value. More...

	setSetting ($name, $value=null)
	Set a setting value. More...

	getSettings ()
	Get an array of all setting values. More...

	setSettings ($settings)
	Set an array of all setting values. More...

	saveSettings ()
	Save setting values. More...

	hasToolSettingsService ()
	Check if the Tool Settings service is supported. More...

	getToolSettings ($simple=true)
	Get Tool Settings. More...

	setToolSettings ($settings=array())
	Perform a Tool Settings service request. More...

	signParameters ($url, $type, $version, $params)
	Add the OAuth signature to an LTI message. More...

	doServiceRequest ($service, $method, $format, $data)
	Perform a service request. More...

Static Public Member Functions
static	addSignature ($endpoint, $consumerKey, $consumerSecret, $data, $method='POST', $type=null)
	Add the OAuth signature to an array of message parameters or to a header string. More...

static	fromRecordId ($id, $dataConnector)
	Load the tool consumer from the database by its record ID. More...

Data Fields
	$name = null
	Local name of tool consumer. More...

	$secret = null
	Shared secret. More...

	$ltiVersion = null
	LTI version (as reported by last tool consumer connection). More...

	$consumerName = null
	Name of tool consumer (as reported by last tool consumer connection). More...

	$consumerVersion = null
	Tool consumer version (as reported by last tool consumer connection). More...

	$consumerGuid = null
	Tool consumer GUID (as reported by first tool consumer connection). More...

	$cssPath = null
	Optional CSS path (as reported by last tool consumer connection). More...

	$protected = false
	Whether the tool consumer instance is protected by matching the consumer_guid value in incoming requests. More...

	$enabled = false
	Whether the tool consumer instance is enabled to accept incoming connection requests. More...

	$enableFrom = null
	Date/time from which the the tool consumer instance is enabled to accept incoming connection requests. More...

	$enableUntil = null
	Date/time until which the tool consumer instance is enabled to accept incoming connection requests. More...

	$lastAccess = null
	Date of last connection from this tool consumer. More...

	$idScope = ToolProvider::ID_SCOPE_ID_ONLY
	Default scope to use when generating an Id value for a user. More...

	$defaultEmail = ''
	Default email address (or email domain) to use when no email address is provided for a user. More...

	$settings = null
	Setting values (LTI parameters, custom parameters and local parameters). More...

	$created = null
	Date/time when the object was created. More...

	$updated = null
	Date/time when the object was last updated. More...

Private Member Functions
	load ($key, $autoEnable=false)
	Load the tool consumer from the database. More...

Private Attributes
	$id = null
	Consumer ID value. More...

	$key = null
	Consumer key value. More...

	$settingsChanged = false
	Whether the settings value have changed since last saved. More...

	$dataConnector = null
	Data connector object or string. More...

Detailed Description

Class to represent a tool consumer.

Author: Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright: IMS Global Learning Consortium Inc

Date: 2016

Version: 3.0.2 @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 19 of file ToolConsumer.php.

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\ToolProvider\ToolConsumer::__construct	(	$key = `null`,
		$dataConnector = `null`,
		$autoEnable = `false`
	)

Class constructor.

Parameters

string	$key	Consumer key
DataConnector	$dataConnector	A data connector object
boolean	$autoEnable	true if the tool consumers is to be enabled automatically (optional, default is false)

Definition at line 157 of file ToolConsumer.php.

    {
 
        $this->initialize();
        if (empty($dataConnector)) {
            $dataConnector = DataConnector::getDataConnector();
        }
        $this->dataConnector = $dataConnector;
        if (!empty($key)) {
            $this->load($key, $autoEnable);
        } else {
            $this->secret = DataConnector::getRandomString(32);
        }
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$dataConnector, IMSGlobal\LTI\ToolProvider\ToolConsumer\$key, IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector\getDataConnector(), IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector\getRandomString(), IMSGlobal\LTI\ToolProvider\ToolConsumer\initialize(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\load().

Here is the call graph for this function:

Member Function Documentation

◆ addSignature()

static IMSGlobal\LTI\ToolProvider\ToolConsumer::addSignature	(	$endpoint,
		$consumerKey,
		$consumerSecret,
		$data,
		$method = `'POST'`,
		$type = `null`
	)

static

Add the OAuth signature to an array of message parameters or to a header string.

Returns: mixed Array of signed message parameters or header string

Definition at line 513 of file ToolConsumer.php.

    {
 
        $params = array();
        if (is_array($data)) {
            $params = $data;
        }
// Check for query parameters which need to be included in the signature
        $queryParams = array();
        $queryString = parse_url($endpoint, PHP_URL_QUERY);
        if (!is_null($queryString)) {
            $queryItems = explode('&', $queryString);
            foreach ($queryItems as $item) {
                if (strpos($item, '=') !== false) {
                    list($name, $value) = explode('=', $item);
                    $queryParams[urldecode($name)] = urldecode($value);
                } else {
                    $queryParams[urldecode($item)] = '';
                }
            }
            $params = $params + $queryParams;
        }
 
        if (!is_array($data)) {
// Calculate body hash
            $hash = base64_encode(sha1($data, true));
            $params['oauth_body_hash'] = $hash;
        }
 
// Add OAuth signature
        $hmacMethod = new OAuth\OAuthSignatureMethod_HMAC_SHA1();
        $oauthConsumer = new OAuth\OAuthConsumer($consumerKey, $consumerSecret, null);
        $oauthReq = OAuth\OAuthRequest::from_consumer_and_token($oauthConsumer, null, $method, $endpoint, $params);
        $oauthReq->sign_request($hmacMethod, $oauthConsumer, null);
        $params = $oauthReq->get_parameters();
// Remove parameters being passed on the query string
        foreach (array_keys($queryParams) as $name) {
            unset($params[$name]);
        }
 
        if (!is_array($data)) {
            $header = $oauthReq->to_header();
            if (empty($data)) {
                if (!empty($type)) {
                    $header .= "\nAccept: {$type}";
                }
            } else if (isset($type)) {
                $header .= "\nContent-Type: {$type}";
                $header .= "\nContent-Length: " . strlen($data);
            }
            return $header;
        } else {
            return $params;
        }
 
    }

References $data, $endpoint, $header, IMSGlobal\LTI\ToolProvider\ToolConsumer\$name, PHPMailer\PHPMailer\$params, $type, and IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token().

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\doServiceRequest(), and IMSGlobal\LTI\ToolProvider\Service\Service\send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

IMSGlobal\LTI\ToolProvider\ToolConsumer::delete ( )

Delete the tool consumer from the database.

Returns: boolean True if the object was successfully deleted

Definition at line 236 of file ToolConsumer.php.

    {
 
        return $this->dataConnector->deleteToolConsumer($this);
 
    }

◆ doServiceRequest()

IMSGlobal\LTI\ToolProvider\ToolConsumer::doServiceRequest	(	$service,
		$method,
		$format,
		$data
	)

Perform a service request.

Parameters

object	$service	Service object to be executed
string	$method	HTTP action
string	$format	Media type
mixed	$data	Array of parameters or body string

Returns: HTTPMessage HTTP object containing request and response details

Definition at line 580 of file ToolConsumer.php.

    {
 
        $header = ToolConsumer::addSignature($service->endpoint, $this->getKey(), $this->secret, $data, $method, $format);
 
// Connect to tool consumer
        $http = new HTTPMessage($service->endpoint, $method, $data, $header);
// Parse JSON response
        if ($http->send() && !empty($http->response)) {
            $http->responseJson = json_decode($http->response);
            $http->ok = !is_null($http->responseJson);
        }
 
        return $http;
 
    }

References $data, $format, $header, $http, and IMSGlobal\LTI\ToolProvider\ToolConsumer\addSignature().

Here is the call graph for this function:

◆ fromRecordId()

static IMSGlobal\LTI\ToolProvider\ToolConsumer::fromRecordId	(	$id,
		$dataConnector
	)

static

Load the tool consumer from the database by its record ID.

Parameters

string	$id	The consumer key record ID
DataConnector	$dataConnector	Database connection object

Returns: object ToolConsumer The tool consumer object

Reimplemented in ilLTIToolConsumer.

Definition at line 605 of file ToolConsumer.php.

    {
 
        $toolConsumer = new ToolConsumer(null, $dataConnector);
 
        $toolConsumer->initialize();
        $toolConsumer->setRecordId($id);
        if (!$dataConnector->loadToolConsumer($toolConsumer)) {
            $toolConsumer->initialize();
        }
 
        return $toolConsumer;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$dataConnector, and IMSGlobal\LTI\ToolProvider\ToolConsumer\$id.

Referenced by IMSGlobal\LTI\ToolProvider\Context\getConsumer(), IMSGlobal\LTI\ToolProvider\ResourceLink\getConsumer(), and IMSGlobal\LTI\ToolProvider\ToolProxy\getConsumer().

Here is the caller graph for this function:

◆ getDataConnector()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getDataConnector ( )

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 296 of file ToolConsumer.php.

    {
 
        return $this->dataConnector;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$dataConnector.

◆ getIsAvailable()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getIsAvailable ( )

Is the consumer key available to accept launch requests?

Returns: boolean True if the consumer key is enabled and within any date constraints

Definition at line 308 of file ToolConsumer.php.

    {
 
        $ok = $this->enabled;
 
        $now = time();
        if ($ok && !is_null($this->enableFrom)) {
            $ok = $this->enableFrom <= $now;
        }
        if ($ok && !is_null($this->enableUntil)) {
            $ok = $this->enableUntil > $now;
        }
 
        return $ok;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$enabled, and $ok.

◆ getKey()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getKey ( )

Get the tool consumer key.

Returns: string Consumer key value

Definition at line 272 of file ToolConsumer.php.

    {
 
        return $this->key;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$key.

Referenced by ilLTIDataConnector\loadToolConsumerILIAS(), ilLTIDataConnector\saveToolConsumerILIAS(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\signParameters().

Here is the caller graph for this function:

◆ getRecordId()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getRecordId ( )

Get the tool consumer record ID.

Returns: int Consumer record ID value

Definition at line 248 of file ToolConsumer.php.

    {
 
        return $this->id;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$id.

Referenced by ilLTIToolConsumer\getId(), ilLTIDataConnector\loadToolConsumerILIAS(), and ilLTIDataConnector\saveToolConsumerILIAS().

Here is the caller graph for this function:

◆ getSetting()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getSetting	(	$name,
		$default = `''`
	)

Get a setting value.

Parameters

string	$name	Name of setting
string	$default	Value to return if the setting does not exist (optional, default is an empty string)

Returns: string Setting value

Definition at line 333 of file ToolConsumer.php.

    {
 
        if (array_key_exists($name, $this->settings)) {
            $value = $this->settings[$name];
        } else {
            $value = $default;
        }
 
        return $value;
 
    }

References $default, IMSGlobal\LTI\ToolProvider\ToolConsumer\$name, and settings().

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\getToolSettings(), IMSGlobal\LTI\ToolProvider\ToolConsumer\hasToolSettingsService(), IMSGlobal\LTI\ToolProvider\ToolConsumer\setSetting(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\setToolSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettings()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getSettings ( )

Get an array of all setting values.

Returns: array Associative array of setting values

Definition at line 372 of file ToolConsumer.php.

    {
 
        return $this->settings;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$settings.

Referenced by ilLTIDataConnector\saveToolConsumerILIAS().

Here is the caller graph for this function:

◆ getToolSettings()

IMSGlobal\LTI\ToolProvider\ToolConsumer::getToolSettings ( $simple = true )

Get Tool Settings.

Parameters

boolean $simple True if all the simple media type is to be used (optional, default is true)

Returns: mixed The array of settings if successful, otherwise false

Definition at line 430 of file ToolConsumer.php.

    {
 
        $url = $this->getSetting('custom_system_setting_url');
        $service = new Service\ToolSettings($this, $url, $simple);
        $response = $service->get();
 
        return $response;
 
    }

References $response, $url, and IMSGlobal\LTI\ToolProvider\ToolConsumer\getSetting().

Here is the call graph for this function:

◆ hasToolSettingsService()

IMSGlobal\LTI\ToolProvider\ToolConsumer::hasToolSettingsService ( )

Check if the Tool Settings service is supported.

Returns: boolean True if this tool consumer supports the Tool Settings service

Definition at line 414 of file ToolConsumer.php.

    {
 
        $url = $this->getSetting('custom_system_setting_url');
 
        return !empty($url);
 
    }

References $url, and IMSGlobal\LTI\ToolProvider\ToolConsumer\getSetting().

Here is the call graph for this function:

◆ initialise()

IMSGlobal\LTI\ToolProvider\ToolConsumer::initialise ( )

Initialise the tool consumer.

Pseudonym for initialize().

Definition at line 207 of file ToolConsumer.php.

    {
 
        $this->initialize();
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\initialize().

Here is the call graph for this function:

◆ initialize()

IMSGlobal\LTI\ToolProvider\ToolConsumer::initialize ( )

Initialise the tool consumer.

Definition at line 176 of file ToolConsumer.php.

    {
 
        $this->id = null;
        $this->key = null;
        $this->name = null;
        $this->secret = null;
        $this->ltiVersion = null;
        $this->consumerName = null;
        $this->consumerVersion = null;
        $this->consumerGuid = null;
        $this->profile = null;
        $this->toolProxy = null;
        $this->settings = array();
        $this->protected = false;
        $this->enabled = false;
        $this->enableFrom = null;
        $this->enableUntil = null;
        $this->lastAccess = null;
        $this->idScope = ToolProvider::ID_SCOPE_ID_ONLY;
        $this->defaultEmail = '';
        $this->created = null;
        $this->updated = null;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_ID_ONLY, and settings().

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\__construct(), ilLTIDataConnector\deleteGlobalToolConsumerSettings(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

IMSGlobal\LTI\ToolProvider\ToolConsumer::load	(	$key,
		$autoEnable = `false`
	)

private

Load the tool consumer from the database.

Parameters

string	$key	The consumer key value
boolean	$autoEnable	True if the consumer should be enabled (optional, default if false)

Returns: boolean True if the consumer was successfully loaded

Definition at line 633 of file ToolConsumer.php.

    {
 
        $this->key = $key;
        $ok = $this->dataConnector->loadToolConsumer($this);
        if (!$ok) {
            $this->enabled = $autoEnable;
        }
 
        return $ok;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$key, and $ok.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\__construct().

Here is the caller graph for this function:

◆ save()

IMSGlobal\LTI\ToolProvider\ToolConsumer::save ( )

Save the tool consumer to the database.

Returns: boolean True if the object was successfully saved

Definition at line 219 of file ToolConsumer.php.

    {
 
        $ok = $this->dataConnector->saveToolConsumer($this);
        if ($ok) {
            $this->settingsChanged = false;
        }
 
        return $ok;
 
    }

References $ok.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\saveSettings().

Here is the caller graph for this function:

◆ saveSettings()

IMSGlobal\LTI\ToolProvider\ToolConsumer::saveSettings ( )

Save setting values.

Returns: boolean True if the settings were successfully saved

Definition at line 396 of file ToolConsumer.php.

    {
 
        if ($this->settingsChanged) {
            $ok = $this->save();
        } else {
            $ok = true;
        }
 
        return $ok;
 
    }

References $ok, and IMSGlobal\LTI\ToolProvider\ToolConsumer\save().

Here is the call graph for this function:

◆ setKey()

IMSGlobal\LTI\ToolProvider\ToolConsumer::setKey ( $key )

Set the tool consumer key.

Parameters

string $key Consumer key value

Definition at line 284 of file ToolConsumer.php.

    {
 
        $this->key = $key;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$key.

◆ setRecordId()

IMSGlobal\LTI\ToolProvider\ToolConsumer::setRecordId ( $id )

Sets the tool consumer record ID.

Parameters

int $id Consumer record ID value

Definition at line 260 of file ToolConsumer.php.

    {
 
        $this->id = $id;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$id.

Referenced by ilLTIDataConnector\loadToolConsumerILIAS(), and ilLTIDataConnector\saveToolConsumerILIAS().

Here is the caller graph for this function:

◆ setSetting()

IMSGlobal\LTI\ToolProvider\ToolConsumer::setSetting	(	$name,
		$value = `null`
	)

Set a setting value.

Parameters

string	$name	Name of setting
string	$value	Value to set, use an empty value to delete a setting (optional, default is null)

Definition at line 352 of file ToolConsumer.php.

    {
 
        $old_value = $this->getSetting($name);
        if ($value !== $old_value) {
            if (!empty($value)) {
                $this->settings[$name] = $value;
            } else {
                unset($this->settings[$name]);
            }
            $this->settingsChanged = true;
        }
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$name, IMSGlobal\LTI\ToolProvider\ToolConsumer\getSetting(), and settings().

Here is the call graph for this function:

◆ setSettings()

IMSGlobal\LTI\ToolProvider\ToolConsumer::setSettings ( $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

Definition at line 384 of file ToolConsumer.php.

    {
 
        $this->settings = $settings;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$settings, and settings().

Referenced by ilLTIDataConnector\loadToolConsumerILIAS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setToolSettings()

IMSGlobal\LTI\ToolProvider\ToolConsumer::setToolSettings ( $settings = array() )

Perform a Tool Settings service request.

Parameters

array $settings An associative array of settings (optional, default is none)

Returns: boolean True if action was successful, otherwise false

Definition at line 448 of file ToolConsumer.php.

    {
 
        $url = $this->getSetting('custom_system_setting_url');
        $service = new Service\ToolSettings($this, $url);
        $response = $service->set($settings);
 
        return $response;
 
    }

References $response, IMSGlobal\LTI\ToolProvider\ToolConsumer\$settings, $url, and IMSGlobal\LTI\ToolProvider\ToolConsumer\getSetting().

Here is the call graph for this function:

◆ signParameters()

IMSGlobal\LTI\ToolProvider\ToolConsumer::signParameters	(	$url,
		$type,
		$version,
		$params
	)

Add the OAuth signature to an LTI message.

Parameters

string	$url	URL for message request
string	$type	LTI message type
string	$version	LTI version
array	$params	Message parameters

Returns: array Array of signed message parameters

Definition at line 469 of file ToolConsumer.php.

    {
 
        if (!empty($url)) {
// Check for query parameters which need to be included in the signature
            $queryParams = array();
            $queryString = parse_url($url, PHP_URL_QUERY);
            if (!is_null($queryString)) {
                $queryItems = explode('&', $queryString);
                foreach ($queryItems as $item) {
                    if (strpos($item, '=') !== false) {
                        list($name, $value) = explode('=', $item);
                        $queryParams[urldecode($name)] = urldecode($value);
                    } else {
                        $queryParams[urldecode($item)] = '';
                    }
                }
            }
            $params = $params + $queryParams;
// Add standard parameters
            $params['lti_version'] = $version;
            $params['lti_message_type'] = $type;
            $params['oauth_callback'] = 'about:blank';
// Add OAuth signature
            $hmacMethod = new OAuth\OAuthSignatureMethod_HMAC_SHA1();
            $consumer = new OAuth\OAuthConsumer($this->getKey(), $this->secret, null);
            $req = OAuth\OAuthRequest::from_consumer_and_token($consumer, null, 'POST', $url, $params);
            $req->sign_request($hmacMethod, $consumer, null);
            $params = $req->get_parameters();
// Remove parameters being passed on the query string
            foreach (array_keys($queryParams) as $name) {
                unset($params[$name]);
            }
        }
 
        return $params;
 
    }

References IMSGlobal\LTI\ToolProvider\ToolConsumer\$name, PHPMailer\PHPMailer\$params, $req, $type, $url, $version, IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\getKey().

Here is the call graph for this function:

Field Documentation

◆ $consumerGuid

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$consumerGuid = null

Tool consumer GUID (as reported by first tool consumer connection).

Definition at line 57 of file ToolConsumer.php.

◆ $consumerName

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$consumerName = null

Name of tool consumer (as reported by last tool consumer connection).

Definition at line 45 of file ToolConsumer.php.

◆ $consumerVersion

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$consumerVersion = null

Tool consumer version (as reported by last tool consumer connection).

Definition at line 51 of file ToolConsumer.php.

◆ $created

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$created = null

Date/time when the object was created.

Definition at line 117 of file ToolConsumer.php.

◆ $cssPath

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$cssPath = null

Optional CSS path (as reported by last tool consumer connection).

Definition at line 63 of file ToolConsumer.php.

◆ $dataConnector

mixed IMSGlobal\LTI\ToolProvider\ToolConsumer::$dataConnector = null

private

Data connector object or string.

Definition at line 148 of file ToolConsumer.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\__construct(), ilLTIToolConsumer\deleteGlobalToolConsumerSettings(), ilLTIToolConsumer\fromExternalConsumerId(), IMSGlobal\LTI\ToolProvider\ToolConsumer\fromRecordId(), ilLTIToolConsumer\fromRecordId(), IMSGlobal\LTI\ToolProvider\ToolConsumer\getDataConnector(), ilLTIToolConsumer\saveGlobalToolConsumerSettings(), and ilLTIToolConsumer\saveLTI().

◆ $defaultEmail

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$defaultEmail = ''

Default email address (or email domain) to use when no email address is provided for a user.

Definition at line 105 of file ToolConsumer.php.

◆ $enabled

boolean IMSGlobal\LTI\ToolProvider\ToolConsumer::$enabled = false

Whether the tool consumer instance is enabled to accept incoming connection requests.

Definition at line 75 of file ToolConsumer.php.

Referenced by ilLTIToolConsumer\getEnabled(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\getIsAvailable().

◆ $enableFrom

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$enableFrom = null

Date/time from which the the tool consumer instance is enabled to accept incoming connection requests.

Definition at line 81 of file ToolConsumer.php.

◆ $enableUntil

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$enableUntil = null

Date/time until which the tool consumer instance is enabled to accept incoming connection requests.

Definition at line 87 of file ToolConsumer.php.

◆ $id

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$id = null

private

Consumer ID value.

Definition at line 130 of file ToolConsumer.php.

Referenced by ilLTIToolConsumer\fromExternalConsumerId(), IMSGlobal\LTI\ToolProvider\ToolConsumer\fromRecordId(), ilLTIToolConsumer\fromRecordId(), IMSGlobal\LTI\ToolProvider\ToolConsumer\getRecordId(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\setRecordId().

◆ $idScope

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$idScope = ToolProvider::ID_SCOPE_ID_ONLY

Default scope to use when generating an Id value for a user.

Definition at line 99 of file ToolConsumer.php.

◆ $key

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$key = null

private

Consumer key value.

Definition at line 136 of file ToolConsumer.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\__construct(), IMSGlobal\LTI\ToolProvider\ToolConsumer\getKey(), IMSGlobal\LTI\ToolProvider\ToolConsumer\load(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\setKey().

◆ $lastAccess

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$lastAccess = null

Date of last connection from this tool consumer.

Definition at line 93 of file ToolConsumer.php.

◆ $ltiVersion

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$ltiVersion = null

LTI version (as reported by last tool consumer connection).

Definition at line 39 of file ToolConsumer.php.

◆ $name

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$name = null

Local name of tool consumer.

Definition at line 27 of file ToolConsumer.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\addSignature(), IMSGlobal\LTI\ToolProvider\ToolConsumer\getSetting(), IMSGlobal\LTI\ToolProvider\ToolConsumer\setSetting(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\signParameters().

◆ $protected

boolean IMSGlobal\LTI\ToolProvider\ToolConsumer::$protected = false

Whether the tool consumer instance is protected by matching the consumer_guid value in incoming requests.

Definition at line 69 of file ToolConsumer.php.

◆ $secret

string IMSGlobal\LTI\ToolProvider\ToolConsumer::$secret = null

Shared secret.

Definition at line 33 of file ToolConsumer.php.

Referenced by ilLTIToolConsumer\getSecret(), and ilLTIToolConsumer\setSecret().

◆ $settings

array IMSGlobal\LTI\ToolProvider\ToolConsumer::$settings = null

Setting values (LTI parameters, custom parameters and local parameters).

Definition at line 111 of file ToolConsumer.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\getSettings(), IMSGlobal\LTI\ToolProvider\ToolConsumer\setSettings(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\setToolSettings().

◆ $settingsChanged

boolean IMSGlobal\LTI\ToolProvider\ToolConsumer::$settingsChanged = false

private

Whether the settings value have changed since last saved.

Definition at line 142 of file ToolConsumer.php.

◆ $updated

int IMSGlobal\LTI\ToolProvider\ToolConsumer::$updated = null

Date/time when the object was last updated.

Definition at line 123 of file ToolConsumer.php.

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

libs/composer/vendor/imsglobal/lti/src/ToolProvider/ToolConsumer.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSignature()

◆ delete()

◆ doServiceRequest()

◆ fromRecordId()

◆ getDataConnector()

◆ getIsAvailable()

◆ getKey()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getToolSettings()

◆ hasToolSettingsService()

◆ initialise()

◆ initialize()

◆ load()

◆ save()

◆ saveSettings()

◆ setKey()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

◆ signParameters()

Field Documentation

◆ $consumerGuid

◆ $consumerName

◆ $consumerVersion

◆ $created

◆ $cssPath

◆ $dataConnector

◆ $defaultEmail

◆ $enabled

◆ $enableFrom

◆ $enableUntil

◆ $id

◆ $idScope

◆ $key

◆ $lastAccess

◆ $ltiVersion

◆ $name

◆ $protected

◆ $secret

◆ $settings

◆ $settingsChanged

◆ $updated