ILIAS\LTI\ToolProvider\Platform Class Reference

Class to represent a platform. More...

Collaboration diagram for ILIAS\LTI\ToolProvider\Platform:

Public Member Functions
	getAccessToken ()
	Get the authorization access token. More...
	setAccessToken (AccessToken $accessToken)
	Set the authorization access token. More...
	__construct (DataConnector $dataConnector=null)
	Class constructor. More...
	initialize ()
	Initialise the platform. More...
	initialise ()
	Initialise the platform. More...
	save ()
	Save the platform to the database. More...
	delete ()
	Delete the platform from the database. More...
	getId ()
	Get the platform ID. More...
	getFamilyCode ()
	Get platform family code (as reported by last platform connection). More...
	getDataConnector ()
	Get the data connector. More...
	getIsAvailable ()
	Is the platform available to accept launch requests? More...
	hasToolSettingsService ()
	Check if the Tool Settings service is supported. More...
	getToolSettings (bool $simple=true)
	Get Tool Settings. More...
	setToolSettings (array $settings=array())
	Set Tool Settings. More...
	getTools ()
	Get an array of defined tools. More...
	hasAccessTokenService ()
	Check if the Access Token service is supported. More...
	getMessageParameters ()
	Get the message parameters. More...
	handleRequest ()
	Process an incoming request. More...

Static Public Member Functions
static	fromConsumerKey (string $key=null, DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the platform from the database by its consumer key. More...

Data Fields
string	$name = null
	Local name of platform. More...
string	$platformId = null
	Platform ID. More...
string	$clientId = null
	Client ID. More...
string	$deploymentId = null
	Deployment ID. More...
string	$authorizationServerId = null
	Authorization server ID. More...
string	$authenticationUrl = null
	Login authentication URL. More...
string	$accessTokenUrl = null
	Access Token service URL. More...
string	$ltiVersion = null
	LTI version (as reported by last platform connection). More...
string	$consumerName = null
	Name of tool consumer (as reported by last tool consumer connection). More...
string	$consumerVersion = null
	Tool consumer version (as reported by last tool consumer connection). More...
object	$profile = null
	The platform profile data. More...
object	$toolProxy = null
	The tool proxy. More...
string	$consumerGuid = null
	Tool consumer GUID (as reported by first tool consumer connection). More...
string	$cssPath = null
	Optional CSS path (as reported by last tool consumer connection). More...
bool	$protected = false
	Whether the platform instance is protected by matching the consumer_guid value in incoming requests. More...
int	$idScope = Tool::ID_SCOPE_ID_ONLY
	Default scope to use when generating an Id value for a user. More...
string	$defaultEmail = ''
	Default email address (or email domain) to use when no email address is provided for a user. More...
HTTPMessage	$lastServiceRequest = null
	HttpMessage object for last service request. More...

Static Public Attributes
static array	$MESSAGE_TYPES
	List of supported incoming message types. More...

Protected Member Functions
	onInitiateLogin (string &$url, string &$loginHint, string &$ltiMessageHint, array $params)
	Load the platform from the database by its platform, client and deployment IDs. More...
	onAuthenticate ()
	Check the hint and recover the message parameters for an authentication request. More...
	onContentItem ()
	Process a valid content-item message. More...
	onLtiStartAssessment ()
	Process a valid start assessment message. More...
	onError ()
	Process a response to an invalid message. More...

Private Member Functions
	authenticate ()
	Check the authenticity of the LTI message. More...
	handleAuthenticationRequest ()
	Process an authentication request. More...

Private Attributes
AccessToken	$accessToken = null
	Access token to authorize service requests. More...

Detailed Description

Class to represent a platform.

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 http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 35 of file Platform.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LTI\ToolProvider\Platform::__construct

(

DataConnector

$dataConnector = null

)

Class constructor.

Parameters

DataConnector | null

$dataConnector

A data connector object

Definition at line 204 of file Platform.php.

References ILIAS\LTI\ToolProvider\$dataConnector, ILIAS\LTI\ToolProvider\DataConnector\DataConnector\getDataConnector(), and ILIAS\LTI\ToolProvider\Platform\initialize().

    {
        $this->initialize();
        if (empty($dataConnector)) {
            $dataConnector = DataConnector::getDataConnector();
        }
        $this->dataConnector = $dataConnector;
    }

Here is the call graph for this function:

Member Function Documentation

authenticate()

ILIAS\LTI\ToolProvider\Platform::authenticate ( )

private

Check the authenticity of the LTI message.

The platform, resource link and user objects will be initialised if the request is valid.

Returns

bool True if the request has been successfully validated.

Definition at line 646 of file Platform.php.

References ILIAS\LTI\ToolProvider\checkMessage(), and ILIAS\LTI\ToolProvider\verifySignature().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest().

                                   : bool
    {
        $this->checkMessage();
        if ($this->ok) {
            $this->ok = $this->verifySignature();
        }

        return $this->ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ILIAS\LTI\ToolProvider\Platform::delete

(

)

Delete the platform from the database.

Returns

bool True if the object was successfully deleted

Definition at line 273 of file Platform.php.

                            : bool
    {
        return $this->dataConnector->deletePlatform($this);
    }

fromConsumerKey()

static ILIAS\LTI\ToolProvider\Platform::fromConsumerKey ( string  $key = null, DataConnector  $dataConnector = null, bool  $autoEnable = false  )

static

Load the platform from the database by its consumer key.

Parameters

string | null	$key	Consumer key
DataConnector | null	$dataConnector	A data connector object
bool	$autoEnable	true if the platform is to be enabled automatically (optional, default is false)

Returns

Platform The platform object

Definition at line 496 of file Platform.php.

References ILIAS\LTI\ToolProvider\$dataConnector, ILIAS\LTI\ToolProvider\$key, and ilLTIDataConnector\loadPlatform().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

                                                                                                                             : Platform
    {
        $platform = new static($dataConnector);
        $platform->key = $key;
        if (!empty($dataConnector)) {
            $ok = $dataConnector->loadPlatform($platform);
            if ($ok && $autoEnable) {
                $platform->enabled = true;
            }
        }

        return $platform;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAccessToken()

ILIAS\LTI\ToolProvider\Platform::getAccessToken

(

)

Get the authorization access token.

Returns

AccessToken Access token

Definition at line 158 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\$accessToken.

                                    : ?AccessToken
    {
        return $this->accessToken;
    }

getDataConnector()

ILIAS\LTI\ToolProvider\Platform::getDataConnector

(

)

Get the data connector.

Returns

DataConnector|null Data connector object or string

Definition at line 328 of file Platform.php.

References ILIAS\LTI\ToolProvider\$dataConnector.

Referenced by ILIAS\LTI\ToolProvider\Context\fromPlatform(), and ILIAS\LTI\ToolProvider\ResourceLink\fromPlatform().

                                      : ?DataConnector
    {
        return $this->dataConnector;
    }

Here is the caller graph for this function:

getFamilyCode()

ILIAS\LTI\ToolProvider\Platform::getFamilyCode

(

)

Get platform family code (as reported by last platform connection).

Returns

string Family code

Definition at line 309 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\$consumerVersion.

Referenced by ILIAS\LTI\ToolProvider\Platform\getToolSettings(), ILIAS\LTI\ToolProvider\Platform\hasAccessTokenService(), ILIAS\LTI\ToolProvider\Platform\hasToolSettingsService(), and ILIAS\LTI\ToolProvider\Platform\setToolSettings().

                                   : ?string
    {
        $familyCode = '';
        if (!empty($this->consumerVersion)) {
            $familyCode = $this->consumerVersion;
            $pos = strpos($familyCode, '-');
            if ($pos !== false) {
                $familyCode = substr($familyCode, 0, $pos);
            }
        }

        return $familyCode;
    }

Here is the caller graph for this function:

getId()

ILIAS\LTI\ToolProvider\Platform::getId

(

)

Get the platform ID.

The ID will be the consumer key if one exists, otherwise a concatenation of the platform/client/deployment IDs

Returns

string Platform ID value

Definition at line 285 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\$clientId, ILIAS\LTI\ToolProvider\Platform\$deploymentId, ILIAS\LTI\ToolProvider\$id, ILIAS\LTI\ToolProvider\$key, and ILIAS\LTI\ToolProvider\Platform\$platformId.

                           : ?string
    {
        if (!empty($this->key)) {
            $id = $this->key;
        } elseif (!empty($this->platformId)) {
            $id = $this->platformId;
            if (!empty($this->clientId)) {
                $id .= '/' . $this->clientId;
            }
            if (!empty($this->deploymentId)) {
                $id .= '#' . $this->deploymentId;
            }
        } else {
            $id = null;
        }

        return $id;
    }

getIsAvailable()

ILIAS\LTI\ToolProvider\Platform::getIsAvailable

(

)

Is the platform available to accept launch requests?

Returns

bool True if the platform is enabled and within any date constraints

Definition at line 338 of file Platform.php.

References ILIAS\LTI\ToolProvider\$enabled.

                                    : bool
    {
        $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;
    }

getMessageParameters()

ILIAS\LTI\ToolProvider\Platform::getMessageParameters

(

)

Get the message parameters.

Returns

array The message parameter array

Definition at line 444 of file Platform.php.

References ILIAS\LTI\ToolProvider\$messageParameters, and ILIAS\LTI\ToolProvider\parseMessage().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest().

                                          : array
    {
        if ($this->ok && is_null($this->messageParameters)) {
            $this->parseMessage();
        }

        return $this->messageParameters;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTools()

ILIAS\LTI\ToolProvider\Platform::getTools

(

)

Get an array of defined tools.

Returns

array Array of Tool objects

Definition at line 420 of file Platform.php.

                              : array
    {
        return $this->dataConnector->getTools();
    }

getToolSettings()

ILIAS\LTI\ToolProvider\Platform::getToolSettings

(

bool

$simple = true

)

Get Tool Settings.

Parameters

bool

$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 372 of file Platform.php.

References $service, ILIAS\LTI\ToolProvider\$settings, ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, $url, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Platform\getFamilyCode(), ILIAS\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

    {
        $ok = false;
        $settings = array();
        if (!empty($this->getSetting('custom_system_setting_url'))) {
            $url = $this->getSetting('custom_system_setting_url');
            $service = new Service\ToolSettings($this, $url, $simple);
            $settings = $service->get();
            $this->lastServiceRequest = $service->getHttpMessage();
            $ok = $settings !== false;
        }
        if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getFamilyCode());
            $hook = new $className($this);
            $settings = $hook->getToolSettings($simple);
        }

        return $settings;
    }

Here is the call graph for this function:

handleAuthenticationRequest()

ILIAS\LTI\ToolProvider\Platform::handleAuthenticationRequest ( )

private

Process an authentication request.

Generates an auto-submit form to respond to the request.

Definition at line 661 of file Platform.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, $scopes, ILIAS\LTI\ToolProvider\addSignature(), exit, ILIAS\LTI\ToolProvider\Util\getRequestParameters(), ILIAS\LTI\ToolProvider\Platform\onAuthenticate(), and ILIAS\LTI\ToolProvider\Util\sendForm().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest().

    {
        $this->messageParameters = array();
        $parameters = Util::getRequestParameters();
        $this->ok = isset($parameters['scope']) && isset($parameters['response_type']) &&
            isset($parameters['client_id']) && isset($parameters['redirect_uri']) &&
            isset($parameters['login_hint']) && isset($parameters['nonce']);
        if (!$this->ok) {
            $this->messageParameters['error'] = 'invalid_request';
        }
        if ($this->ok) {
            $scopes = explode(' ', $parameters['scope']);
            $this->ok = in_array('openid', $scopes);
            if (!$this->ok) {
                $this->messageParameters['error'] = 'invalid_scope';
            }
        }
        if ($this->ok && ($parameters['response_type'] !== 'id_token')) {
            $this->ok = false;
            $this->messageParameters['error'] = 'unsupported_response_type';
        }
        if ($this->ok && ($parameters['client_id'] !== $this->clientId)) {
            $this->ok = false;
            $this->messageParameters['error'] = 'unauthorized_client';
        }
        if ($this->ok) {
            $this->ok = in_array($parameters['redirect_uri'], Tool::$defaultTool->redirectionUris);
            if (!$this->ok) {
                $this->messageParameters['error'] = 'invalid_request';
                $this->messageParameters['error_description'] = 'Unregistered redirect_uri';
            }
        }
        if ($this->ok) {
            if (isset($parameters['response_mode'])) {
                $this->ok = ($parameters['response_mode'] === 'form_post');
            } else {
                $this->ok = false;
            }
            if (!$this->ok) {
                $this->messageParameters['error'] = 'invalid_request';
                $this->messageParameters['error_description'] = 'Invalid response_mode';
            }
        }
        if ($this->ok && (!isset($parameters['prompt']) || ($parameters['prompt'] !== 'none'))) {
            $this->ok = false;
            $this->messageParameters['error'] = 'invalid_request';
            $this->messageParameters['error_description'] = 'Invalid prompt';
        }

        if ($this->ok) {
            $this->onAuthenticate();
        }
        if ($this->ok) {
            $this->messageParameters = $this->addSignature(
                Tool::$defaultTool->messageUrl,
                $this->messageParameters,
                'POST',
                null,
                $parameters['nonce']
            );
        }
        if (isset($parameters['state'])) {
            $this->messageParameters['state'] = $parameters['state'];
        }
        $html = Util::sendForm($parameters['redirect_uri'], $this->messageParameters);
        echo $html;
        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleRequest()

ILIAS\LTI\ToolProvider\Platform::handleRequest

(

)

Process an incoming request.

Definition at line 456 of file Platform.php.

References ILIAS\LTI\ToolProvider\Util\$logLevel, ILIAS\LTI\ToolProvider\Platform\authenticate(), ILIAS\LTI\ToolProvider\doCallback(), ILIAS\LTI\ToolProvider\Platform\getMessageParameters(), ILIAS\LTI\ToolProvider\Util\getRequestParameters(), ILIAS\LTI\ToolProvider\Platform\handleAuthenticationRequest(), ILIAS\LTI\ToolProvider\Util\logError(), ILIAS\LTI\ToolProvider\Util\LOGLEVEL_DEBUG, ILIAS\LTI\ToolProvider\Util\logRequest(), and ILIAS\LTI\ToolProvider\Platform\onError().

    {
        $parameters = Util::getRequestParameters();
        if ($this->debugMode) {
            Util::$logLevel = Util::LOGLEVEL_DEBUG;
        }
        if ($this->ok) {
            if (!empty($parameters['client_id'])) {  // Authentication request
                Util::logRequest();
                $this->handleAuthenticationRequest();
            } else {  // LTI message
                $this->getMessageParameters();
                Util::logRequest();
                if ($this->ok && $this->authenticate()) {
                    $this->doCallback();
                }
            }
        }
        if (!$this->ok) {
            $this->onError();
        }
        if (!$this->ok) {
            $errorMessage = "Request failed with reason: '{$this->reason}'";
            if (!empty($this->details)) {
                $errorMessage .= PHP_EOL . 'Debug information:';
                foreach ($this->details as $detail) {
                    $errorMessage .= PHP_EOL . "  {$detail}";
                }
            }
            Util::logError($errorMessage);
        }
    }

Here is the call graph for this function:

hasAccessTokenService()

ILIAS\LTI\ToolProvider\Platform::hasAccessTokenService

(

)

Check if the Access Token service is supported.

Returns

bool True if this platform supports the Access Token service

Definition at line 430 of file Platform.php.

References ILIAS\LTI\ToolProvider\ApiHook\$ACCESS_TOKEN_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Platform\getFamilyCode(), ILIAS\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                           : bool
    {
        $has = !empty($this->getSetting('custom_oauth2_access_token_url'));
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$ACCESS_TOKEN_SERVICE_HOOK, $this->getFamilyCode(), $this);
        }
        return $has;
    }

Here is the call graph for this function:

hasToolSettingsService()

ILIAS\LTI\ToolProvider\Platform::hasToolSettingsService

(

)

Check if the Tool Settings service is supported.

Returns

bool True if this platform supports the Tool Settings service

Definition at line 358 of file Platform.php.

References ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Platform\getFamilyCode(), ILIAS\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                            : bool
    {
        $has = !empty($this->getSetting('custom_system_setting_url'));
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getFamilyCode(), $this);
        }
        return $has;
    }

Here is the call graph for this function:

initialise()

ILIAS\LTI\ToolProvider\Platform::initialise

(

)

Initialise the platform.

Synonym for initialize().

Definition at line 253 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\initialize().

    {
        $this->initialize();
    }

Here is the call graph for this function:

initialize()

ILIAS\LTI\ToolProvider\Platform::initialize

(

)

Initialise the platform.

Definition at line 216 of file Platform.php.

References ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_ID_ONLY, and ILIAS\Repository\settings().

Referenced by ILIAS\LTI\ToolProvider\Platform\__construct(), ILIAS\LTI\ToolProvider\DataConnector\DataConnector\deletePlatform(), and ILIAS\LTI\ToolProvider\Platform\initialise().

    {
        $this->id = null;
        $this->key = null;
        $this->name = null;
        $this->secret = null;
        $this->signatureMethod = 'HMAC-SHA1';
        $this->encryptionMethod = ''; //changed from null
        $this->rsaKey = null;
        $this->kid = null;
        $this->jku = null;
        $this->platformId = null;
        $this->clientId = null;
        $this->deploymentId = 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 = Tool::ID_SCOPE_ID_ONLY;
        $this->defaultEmail = '';
        $this->created = null;
        $this->updated = null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

onAuthenticate()

ILIAS\LTI\ToolProvider\Platform::onAuthenticate ( )

protected

Check the hint and recover the message parameters for an authentication request.

Override this method if the data has been saved elsewhere.

Definition at line 585 of file Platform.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, and ILIAS\LTI\ToolProvider\Util\getRequestParameters().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleAuthenticationRequest().

    {
        $hasSession = !empty(session_id());
        if (!$hasSession) {
            session_start();
        }
        if (isset($_SESSION['ceLTIc_lti_initiated_login'])) {
            $login = $_SESSION['ceLTIc_lti_initiated_login'];
            $parameters = Util::getRequestParameters();
            if ($parameters['login_hint'] !== $login['login_hint'] ||
                (isset($login['lti_message_hint']) && (!isset($parameters['lti_message_hint']) || ($parameters['lti_message_hint'] !== $login['lti_message_hint'])))) {
                $this->ok = false;
                $this->messageParameters['error'] = 'access_denied';
            } else {
                Tool::$defaultTool->messageUrl = $login['messageUrl'];
                $this->messageParameters = $login['params'];
            }
            unset($_SESSION['ceLTIc_lti_initiated_login']);
        }
        if (!$hasSession) {
            session_write_close();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

onContentItem()

ILIAS\LTI\ToolProvider\Platform::onContentItem ( )

protected

Process a valid content-item message.

Definition at line 612 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\onError().

    {
        $this->reason = 'No onContentItem method found for platform';
        $this->onError();
    }

Here is the call graph for this function:

onError()

ILIAS\LTI\ToolProvider\Platform::onError ( )

protected

Process a response to an invalid message.

Definition at line 630 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Platform\onContentItem(), and ILIAS\LTI\ToolProvider\Platform\onLtiStartAssessment().

    {
        $this->ok = false;
    }

Here is the caller graph for this function:

onInitiateLogin()

ILIAS\LTI\ToolProvider\Platform::onInitiateLogin ( string &  $url, string &  $loginHint, string &  $ltiMessageHint, array  $params  )

protected

Load the platform from the database by its platform, client and deployment IDs.

Parameters

string	$platformId	The platform ID
string	$clientId	The client ID
string	$deploymentId	The deployment ID
DataConnector | null	$dataConnector	A data connector object
bool	$autoEnable	True if the platform is to be enabled automatically (optional, default is false)

Returns

Platform The platform object Load the platform from the database by its record ID.

Parameters

int	$id	The platform record ID //UK: changed to int
DataConnector	$dataConnector	A data connector object

Returns

Platform The platform object Save the hint and message parameters when sending an initiate login request. Override this method to save the data elsewhere.

Parameters

string	$url	The message URL
string	$loginHint	The ID of the user
string	$ltiMessageHint	The message hint being sent to the tool
array	$params	An associative array of message parameters

Definition at line 563 of file Platform.php.

    {
        $hasSession = !empty(session_id());
        if (!$hasSession) {
            session_start();
        }
        $_SESSION['ceLTIc_lti_initiated_login'] = array(
            'messageUrl' => $url,
            'login_hint' => $loginHint,
            'lti_message_hint' => $ltiMessageHint,
            'params' => $params
        );
        if (!$hasSession) {
            session_write_close();
        }
    }

onLtiStartAssessment()

ILIAS\LTI\ToolProvider\Platform::onLtiStartAssessment ( )

protected

Process a valid start assessment message.

Definition at line 621 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\onError().

    {
        $this->reason = 'No onLtiStartAssessment method found for platform';
        $this->onError();
    }

Here is the call graph for this function:

save()

ILIAS\LTI\ToolProvider\Platform::save

(

)

Save the platform to the database.

Returns

bool True if the object was successfully saved

Definition at line 263 of file Platform.php.

                          : bool
    {
        return $this->dataConnector->savePlatform($this);
    }

setAccessToken()

ILIAS\LTI\ToolProvider\Platform::setAccessToken

(

AccessToken

$accessToken

)

Set the authorization access token.

Parameters

AccessToken

$accessToken

Access token

Definition at line 167 of file Platform.php.

References ILIAS\LTI\ToolProvider\Platform\$accessToken.

    {
        $this->accessToken = $accessToken;
    }

setToolSettings()

ILIAS\LTI\ToolProvider\Platform::setToolSettings

(

array

$settings = array()

)

Set Tool Settings.

Parameters

array

$settings

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

Returns

bool True if action was successful, otherwise false

Definition at line 397 of file Platform.php.

References $service, ILIAS\LTI\ToolProvider\$settings, ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, $url, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Platform\getFamilyCode(), ILIAS\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                                              : bool
    {
        $ok = false;
        if (!empty($this->getSetting('custom_system_setting_url'))) {
            $url = $this->getSetting('custom_system_setting_url');
            $service = new Service\ToolSettings($this, $url);
            $ok = $service->set($settings);
            $this->lastServiceRequest = $service->getHttpMessage();
        }
        if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getFamilyCode());
            $hook = new $className($this);
            $ok = $hook->setToolSettings($settings);
        }

        return $ok;
    }

Here is the call graph for this function:

Field Documentation

$accessToken

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

private

Access token to authorize service requests.

Definition at line 151 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\getAccessToken(), and ILIAS\LTI\ToolProvider\Platform\setAccessToken().

$accessTokenUrl

string null ILIAS\LTI\ToolProvider\Platform::$accessTokenUrl = null

Access Token service URL.

Definition at line 95 of file Platform.php.

$authenticationUrl

string null ILIAS\LTI\ToolProvider\Platform::$authenticationUrl = null

Login authentication URL.

Definition at line 88 of file Platform.php.

$authorizationServerId

string null ILIAS\LTI\ToolProvider\Platform::$authorizationServerId = null

Authorization server ID.

Definition at line 81 of file Platform.php.

$clientId

string null ILIAS\LTI\ToolProvider\Platform::$clientId = null

Client ID.

Definition at line 67 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\getId().

$consumerGuid

string null ILIAS\LTI\ToolProvider\Platform::$consumerGuid = null

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

Definition at line 137 of file Platform.php.

$consumerName

string null ILIAS\LTI\ToolProvider\Platform::$consumerName = null

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

Definition at line 109 of file Platform.php.

$consumerVersion

string null ILIAS\LTI\ToolProvider\Platform::$consumerVersion = null

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

Definition at line 116 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\getFamilyCode().

$cssPath

string ILIAS\LTI\ToolProvider\Platform::$cssPath = null

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

Definition at line 144 of file Platform.php.

$defaultEmail

string ILIAS\LTI\ToolProvider\Platform::$defaultEmail = ''

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

Definition at line 191 of file Platform.php.

$deploymentId

string null ILIAS\LTI\ToolProvider\Platform::$deploymentId = null

Deployment ID.

Definition at line 74 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\getId().

$idScope

int ILIAS\LTI\ToolProvider\Platform::$idScope = Tool::ID_SCOPE_ID_ONLY

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

Definition at line 184 of file Platform.php.

$lastServiceRequest

HttpMessage null ILIAS\LTI\ToolProvider\Platform::$lastServiceRequest = null

HttpMessage object for last service request.

Definition at line 198 of file Platform.php.

$ltiVersion

string null ILIAS\LTI\ToolProvider\Platform::$ltiVersion = null

LTI version (as reported by last platform connection).

Definition at line 102 of file Platform.php.

$MESSAGE_TYPES

array ILIAS\LTI\ToolProvider\Platform::$MESSAGE_TYPES

static

Initial value:

= array(
        'ContentItemSelection',
        'LtiStartAssessment'
    )

List of supported incoming message types.

Definition at line 43 of file Platform.php.

$name

string null ILIAS\LTI\ToolProvider\Platform::$name = null

Local name of platform.

Definition at line 53 of file Platform.php.

$platformId

string null ILIAS\LTI\ToolProvider\Platform::$platformId = null

Platform ID.

Definition at line 60 of file Platform.php.

Referenced by ILIAS\LTI\ToolProvider\Platform\getId().

$profile

object null ILIAS\LTI\ToolProvider\Platform::$profile = null

The platform profile data.

Definition at line 123 of file Platform.php.

$protected

bool ILIAS\LTI\ToolProvider\Platform::$protected = false

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

Definition at line 177 of file Platform.php.

$toolProxy

object null ILIAS\LTI\ToolProvider\Platform::$toolProxy = null

The tool proxy.

Definition at line 130 of file Platform.php.

---

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

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