System.php File Reference

Go to the source code of this file.

Namespaces
namespace	ILIAS\LTI\ToolProvider
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

Functions
	ILIAS\LTI\ToolProvider::getRecordId ()
	Get the system record ID. More...
	ILIAS\LTI\ToolProvider::setRecordId (int $id)
	Sets the system record ID. More...
	ILIAS\LTI\ToolProvider::getKey ()
	Get the consumer key. More...
	ILIAS\LTI\ToolProvider::setKey (string $key)
	Set the consumer key. More...
	ILIAS\LTI\ToolProvider::getSetting (string $name, string $default='')
	Get a setting value. More...
	ILIAS\LTI\ToolProvider::setSetting (string $name, string $value=null)
	Set a setting value. More...
	ILIAS\LTI\ToolProvider::getSettings ()
	Get an array of all setting values. More...
	ILIAS\LTI\ToolProvider::setSettings (array $settings)
	Set an array of all setting values. More...
	ILIAS\LTI\ToolProvider::saveSettings ()
	Save setting values. More...
	ILIAS\LTI\ToolProvider::hasJwt ()
	Check whether a JWT exists. More...
	ILIAS\LTI\ToolProvider::getJwt ()
	Get the JWT. More...
	ILIAS\LTI\ToolProvider::getRawParameters ()
	Get the raw POST parameters. More...
	ILIAS\LTI\ToolProvider::getMessageClaims (bool $fullyQualified=false)
	Get the message claims. More...
static	ILIAS\LTI\ToolProvider::parseRoles ($roles, string $ltiVersion=Util::LTI_VERSION1)
	Get an array of fully qualified user roles. More...
	ILIAS\LTI\ToolProvider::signParameters (string $url, string $type, string $version, array $params)
	Add the signature to an LTI message. More...
	ILIAS\LTI\ToolProvider::signMessage (string &$url, string $type, string $version, array $params, string $loginHint=null, string $ltiMessageHint=null)
	Add the signature to an LTI message. More...
	ILIAS\LTI\ToolProvider::sendMessage (string $url, string $type, array $messageParams, string $target='', ?string $userId=null, string $hint='')
	Generate a web page containing an auto-submitted form of LTI message parameters. More...
	ILIAS\LTI\ToolProvider::signServiceRequest (string $url, string $method, string $type, $data=null)
	Generates the headers for an LTI service request. More...
	ILIAS\LTI\ToolProvider::doServiceRequest (object $service, string $method, string $format, $data)
	Perform a service request. More...
	ILIAS\LTI\ToolProvider::useOAuth1 ()
	Determine whether this consumer is using the OAuth 1 security model. More...
	ILIAS\LTI\ToolProvider::addSignature (string $endpoint, $data, string $method='POST', ?string $type=null, ?string $nonce='', ?string $hash=null, ?int $timestamp=null)
	Add the signature to an array of message parameters or to a header string. More...
	ILIAS\LTI\ToolProvider::checkMessage ()
	Verify the required properties of an LTI message. More...
	ILIAS\LTI\ToolProvider::verifySignature ()
	Verify the signature of a message. More...
	ILIAS\LTI\ToolProvider::parseMessage ()
	Parse the message. More...
	ILIAS\LTI\ToolProvider::parseClaims ()
	Parse the claims. More...
	ILIAS\LTI\ToolProvider::doCallback ()
	Call any callback function for the requested action. More...
	ILIAS\LTI\ToolProvider::addOAuth1Signature (string $endpoint, $data, string $method, ?string $type, ?string $hash, ?int $timestamp)
	Add the OAuth 1 signature to an array of message parameters or to a header string. More...
	ILIAS\LTI\ToolProvider::addJWTSignature (string $endpoint, $data, string $method, ?string $type, ?string $nonce, ?int $timestamp)
	Add the JWT signature to an array of message parameters or to a header string. More...
static	ILIAS\LTI\ToolProvider::fullyQualifyClaim (string $claim, string $value)
	Expand a claim into an array of individual fully-qualified claims. More...

Variables
trait	ILIAS\LTI\ToolProvider::System
string	ILIAS\LTI\ToolProvider::$secret = null
	Shared secret. More...
string	ILIAS\LTI\ToolProvider::$signatureMethod = 'HMAC-SHA1'
	Method used for signing messages. More...
string	ILIAS\LTI\ToolProvider::$encryptionMethod = ''
	Algorithm used for encrypting messages. More...
ilLTIDataConnector	ILIAS\LTI\ToolProvider::$dataConnector = null
	Data connector object. More...
string	ILIAS\LTI\ToolProvider::$rsaKey = null
	RSA key in PEM or JSON format. More...
array	ILIAS\LTI\ToolProvider::$requiredScopes = array()
	Scopes to request when obtaining an access token. More...
string	ILIAS\LTI\ToolProvider::$kid = null
	Key ID. More...
string	ILIAS\LTI\ToolProvider::$jku = null
	Endpoint for public key. More...
string	ILIAS\LTI\ToolProvider::$reason = null
	Error message for last request processed. More...
array	ILIAS\LTI\ToolProvider::$details = array()
	Details for error message relating to last request processed. More...
bool	ILIAS\LTI\ToolProvider::$debugMode = false
	Whether debug level messages are to be reported. More...
bool	ILIAS\LTI\ToolProvider::$enabled = false
	Whether the system instance is enabled to accept connection requests. More...
int	ILIAS\LTI\ToolProvider::$enableFrom = null
	Timestamp from which the the system instance is enabled to accept connection requests. More...
int	ILIAS\LTI\ToolProvider::$enableUntil = null
	Timestamp until which the system instance is enabled to accept connection requests. More...
int	ILIAS\LTI\ToolProvider::$lastAccess = null
	Timestamp for date of last connection to this system. More...
int	ILIAS\LTI\ToolProvider::$created = null
	Timestamp for when the object was created. More...
int	ILIAS\LTI\ToolProvider::$updated = null
	Timestamp for when the object was last updated. More...
ClientInterface	ILIAS\LTI\ToolProvider::$jwt = null
	JWT object, if any. More...
array	ILIAS\LTI\ToolProvider::$rawParameters = null
	Raw message parameters. More...
array	ILIAS\LTI\ToolProvider::$messageParameters = null
	LTI message parameters. More...
int	ILIAS\LTI\ToolProvider::$id = null
	System ID value. More...
string	ILIAS\LTI\ToolProvider::$key = null
	Consumer key/client ID value. More...
array	ILIAS\LTI\ToolProvider::$settings = []
	Setting values (LTI parameters, custom parameters and local parameters). More...
bool	ILIAS\LTI\ToolProvider::$settingsChanged = false
	Whether the settings value have changed since last saved. More...