Collaboration diagram for ILIAS\LTI\ToolProvider\Util:

Static Public Member Functions
static	isLtiMessage ()
	Check whether the request received could be an LTI message. More...

static	getRequestParameters ()
	Return GET and POST request parameters (POST parameters take precedence) More...

static	logError (string $message, bool $showSource=true)
	Log an error message. More...

static	logInfo (string $message, bool $showSource=false)
	Log an information message. More...

static	logDebug (string $message, bool $showSource=false)
	Log a debug message. More...

static	logRequest (bool $debugLevel=false)
	Log a request received. More...

static	logForm (string $url, array $params, string $method='POST', bool $debugLevel=false)
	Log a form submission. More...

static	log (string $message, bool $showSource=false)
	Log an error message irrespective of the logging level. More...

static	sendForm (string $url, array $params, string $target='')
	Generate a web page containing an auto-submitted form of parameters. More...

static	redirect (string $url, array $params)
	Redirect to a URL with query parameters. More...

static	getRandomString (int $length=8)
	Generate a random string. More...

static	stripHtml (string $html)
	Strip HTML tags from a string. More...

static	cloneObject (object $obj)
	Clone an object and any objects it contains. More...

static	logtxt (string $msg)

Data Fields
const	LTI_VERSION1 = 'LTI-1p0'
	LTI version 1 for messages. More...

const	LTI_VERSION1P3 = '1.3.0'
	LTI version 1.3 for messages. More...

const	LTI_VERSION2 = 'LTI-2p0'
	LTI version 2 for messages. More...

const	JWT_CLAIM_PREFIX = 'https://purl.imsglobal.org/spec/lti'
	Prefix for standard JWT message claims. More...

const	MESSAGE_TYPE_MAPPING
	Mapping for standard message types. More...

const	JWT_CLAIM_MAPPING
	Mapping for standard message parameters to JWT claim. More...

const	LOGLEVEL_NONE = 0
	No logging. More...

const	LOGLEVEL_ERROR = 1
	Log errors only. More...

const	LOGLEVEL_INFO = 2
	Log error and information messages. More...

const	LOGLEVEL_DEBUG = 3
	Log all messages. More...

Static Public Attributes
static array	$LTI_VERSIONS = array(self::LTI_VERSION1, self::LTI_VERSION1P3, self::LTI_VERSION2)
	Permitted LTI versions for messages. More...

static array	$METHOD_NAMES
	List of supported message types and associated class methods. More...

static array	$requestParameters = null
	GET and POST request parameters. More...

static int	$logLevel = self::LOGLEVEL_NONE
	Current logging level. More...

Detailed Description

Definition at line 23 of file Util.php.

Member Function Documentation

◆ cloneObject()

static ILIAS\LTI\ToolProvider\Util::cloneObject ( object $obj )

static

Clone an object and any objects it contains.

Parameters

object $obj Object to be cloned

Returns: object

Definition at line 590 of file Util.php.

                                                   : object
    {
        $clone = clone $obj;
        $objVars = get_object_vars($clone);
        foreach ($objVars as $attrName => $attrValue) {
            if (is_object($clone->$attrName)) {
                $clone->$attrName = self::cloneObject($clone->$attrName);
            } elseif (is_array($clone->$attrName)) {
                foreach ($clone->$attrName as &$attrArrayValue) {
                    if (is_object($attrArrayValue)) {
                        $attrArrayValue = self::cloneObject($attrArrayValue);
                    }
                    unset($attrArrayValue);
                }
            }
        }
 
        return $clone;
    }

References ILIAS\LTI\ToolProvider\Util\cloneObject().

Referenced by ILIAS\LTI\ToolProvider\Util\cloneObject(), and ILIAS\LTI\ToolProvider\parseClaims().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRandomString()

static ILIAS\LTI\ToolProvider\Util::getRandomString ( int $length = 8 )

static

Generate a random string.

The generated string will only comprise letters (upper- and lower-case) and digits.

Parameters

int $length Length of string to be generated (optional, default is 8 characters)

Returns: string Random string

Definition at line 558 of file Util.php.

                                                           : string
    {
        $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 
        $value = '';
        $charsLength = strlen($chars) - 1;
 
        for ($i = 1; $i <= $length; $i++) {
            $value .= $chars[rand(0, $charsLength)];
        }
 
        return $value;
    }

References $i.

Referenced by ILIAS\LTI\ToolProvider\addJWTSignature(), ilObjLTIConsumer\getNewClientId(), ILIAS\LTI\ToolProvider\ResourceLinkShareKey\save(), ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest(), and ILIAS\LTI\ToolProvider\Tool\sendRelaunchRequest().

Here is the caller graph for this function:

◆ getRequestParameters()

static ILIAS\LTI\ToolProvider\Util::getRequestParameters ( )

static

Return GET and POST request parameters (POST parameters take precedence)

Returns: array|null

Definition at line 224 of file Util.php.

                                                 : ?array
    {
        if (is_null(self::$requestParameters)) {
//            special for ILIAS instead of
//            self::$requestParameters = array_merge($_GET, $_POST);
//            also not possible
//            self::$requestParameters = array_merge(
//                //Argument 1 passed to Symfony\Component\HttpFoundation\Request::createRequestFromFactory() must be of the type array, object given
//                (array) \Symfony\Component\HttpFoundation\Request::createFromGlobals()->query->all(),
//                (array) \Symfony\Component\HttpFoundation\Request::createFromGlobals()->request->all()
//                (array) $_GET, (array) $_POST
//            );
            global $DIC;
            $post = $DIC->http()->wrapper()->post();
            $query = $DIC->http()->wrapper()->query();
            $refinery = $DIC->refinery()->kindlyTo()->string();
 
            $divAr = ['accept_copy_advice',
                          'accept_media_types',
                          'accept_multiple',
                          'accept_presentation_document_targets',
                          'accept_types',
                          'accept_unsigned',
                          'auto_create',
                          'can_confirm',
                          'client_id',
                          'content_item_return_url',
                          'context_id',
                          'context_title',
                          'context_type',
                          'custom_ap_attempt_number',
                          'custom_content_item_id',
                          'custom_share_key',
                          'custom_tc_profile_url',
                          'custom_user_username',
                          'custom_username',
                          'deployment_id',
                          'ext_launch_presentation_css_url',
                          'ext_lms',
                          'ext_user_username',
                          'ext_username',
                          'iss',
                          'launch_presentation_css_url',
                          'launch_presentation_document_target',
                          'launch_presentation_height',
                          'launch_presentation_return_url',
                          'launch_presentation_width',
                          'lis_person_contact_email_primary',
                          'lis_person_name_family',
                          'lis_person_name_full',
                          'lis_person_name_given',
                          'lis_person_sourcedid',
                          'login_hint',
                          'lti_deployment_id',
                          'lti_message_hint',
                          'lti_message_type',
                          'lti_version',
                          'oauth_consumer_key',
                          'oauth_signature_method',
                          'openid_configuration',
                          'platform_state',
                          'reg_key',
                          'reg_password',
                          'registration_token',
                          'relaunch_url',
                          'resource_link_id',
                          'resource_link_title',
                          'roles',
                          'target_link_uri',
                          'tc_profile_url',
                          'tool_consumer_info_product_family_code',
                          'tool_consumer_info_version',
                          'tool_consumer_instance_guid',
                          'tool_consumer_instance_name',
                          'user_id',
                          'user_image'
            ];
            $LTI_CONSUMER_SETTING_NAMES = ['custom_tc_profile_url', 'custom_system_setting_url', 'custom_oauth2_access_token_url'];
            $LTI_CONTEXT_SETTING_NAMES = ['custom_context_setting_url',
                                               'ext_ims_lis_memberships_id', 'ext_ims_lis_memberships_url',
                                               'custom_context_memberships_url', 'custom_context_memberships_v2_url',
                                               'custom_context_group_sets_url', 'custom_context_groups_url',
                                               'custom_lineitems_url', 'custom_ags_scopes'
            ];
            $LTI_RESOURCE_LINK_SETTING_NAMES = ['lis_result_sourcedid', 'lis_outcome_service_url',
                                                     'ext_ims_lis_basic_outcome_url', 'ext_ims_lis_resultvalue_sourcedids', 'ext_outcome_data_values_accepted',
                                                     'ext_ims_lis_memberships_id', 'ext_ims_lis_memberships_url',
                                                     'ext_ims_lti_tool_setting', 'ext_ims_lti_tool_setting_id', 'ext_ims_lti_tool_setting_url',
                                                     'custom_link_setting_url', 'custom_link_memberships_url',
                                                     'custom_lineitems_url', 'custom_lineitem_url', 'custom_ags_scopes',
                                                     'custom_ap_acs_url'
            ];
 
            $requestAr = array_merge($divAr, $LTI_CONSUMER_SETTING_NAMES, $LTI_CONTEXT_SETTING_NAMES, $LTI_RESOURCE_LINK_SETTING_NAMES);
 
            foreach ($requestAr as $param) {
                if ($query->has($param)) {
                    self::$requestParameters[$param] = $query->retrieve($param, $refinery);
                }
                if ($post->has($param)) {
                    self::$requestParameters[$param] = $post->retrieve($param, $refinery);
                }
            }
        }
        return self::$requestParameters;
    }

References $DIC, $param, $post, $query, ILIAS\Repository\$refinery, and ILIAS\LTI\ToolProvider\Util\$requestParameters.

Referenced by ILIAS\LTI\ToolProvider\Tool\getPlatformConfiguration(), ILIAS\LTI\ToolProvider\Platform\handleAuthenticationRequest(), ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Tool\handleRequest(), ILIAS\LTI\ToolProvider\Platform\onAuthenticate(), and ILIAS\LTI\ToolProvider\Tool\sendRegistration().

Here is the caller graph for this function:

◆ isLtiMessage()

static ILIAS\LTI\ToolProvider\Util::isLtiMessage ( )

static

Check whether the request received could be an LTI message.

Returns: bool

Definition at line 196 of file Util.php.

                                         : bool
    {
//        $isLti = ($_SERVER['REQUEST_METHOD'] === 'POST') &&
//            (!empty($_POST['lti_message_type']) || !empty($_POST['id_token']) || !empty($_POST['JWT']) ||
//                !empty($_POST['iss']));
//        if (!$isLti) {
//            $isLti = ($_SERVER['REQUEST_METHOD'] === 'GET') && (!empty($_GET['iss']) || !empty($_GET['openid_configuration']));
//        }
        global $DIC;
        $wrapper = $DIC->http()->wrapper()->post();
        $refString = $DIC->refinery()->kindlyTo()->string();
        $isLti = ($wrapper->has('lti_message_type') && $wrapper->retrieve('lti_message_type', $refString) != '') ||
            ($wrapper->has('id_token') && $wrapper->retrieve('id_token', $refString) != '') ||
            ($wrapper->has('JWT') && $wrapper->retrieve('JWT', $refString) != '') ||
            ($wrapper->has('iss') && $wrapper->retrieve('iss', $refString) != '');
        if (!$isLti) {
            $wrapper = $DIC->http()->wrapper()->query();
            $isLti = ($wrapper->has('iss') && $wrapper->retrieve('iss', $refString) != '') ||
                ($wrapper->has('openid_configuration') && $wrapper->retrieve('openid_configuration', $refString) != '');
        }
        return $isLti;
    }

References $DIC.

◆ log()

static ILIAS\LTI\ToolProvider\Util::log	(	string	$message,
		bool	$showSource = `false`
	)

static

Log an error message irrespective of the logging level.

Parameters

string	$message	Message to be logged
bool	$showSource	True if the name and line number of the current file are to be included

Returns: void

Definition at line 439 of file Util.php.

    {
        $source = '';
        if ($showSource) {
            $backtraces = debug_backtrace();
            foreach ($backtraces as $backtrace) {
                if (isset($backtrace['file'])) {
                    $source .= PHP_EOL . "  {$backtrace['file']}";
                    if (isset($backtrace['line'])) {
                        $source .= " line {$backtrace['line']}";
                    }
                }
            }
            if (!empty($source)) {
                $source = PHP_EOL . "See: {$source}";
            }
        }
        error_log($message . $source);
    }

References $message, and $source.

Referenced by ILIAS\LTI\ToolProvider\Util\logDebug(), ILIAS\LTI\ToolProvider\Util\logError(), and ILIAS\LTI\ToolProvider\Util\logInfo().

Here is the caller graph for this function:

◆ logDebug()

static ILIAS\LTI\ToolProvider\Util::logDebug	(	string	$message,
		bool	$showSource = `false`
	)

static

Log a debug message.

Parameters

string	$message	Message to be logged
bool	$showSource	True if the name and line number of the current file are to be included

Returns: void

Definition at line 363 of file Util.php.

    {
        if (self::$logLevel >= self::LOGLEVEL_DEBUG) {
            self::log("[DEBUG] {$message}", $showSource);
        }
    }

References ILIAS\LTI\ToolProvider\Util\log().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logError()

static ILIAS\LTI\ToolProvider\Util::logError	(	string	$message,
		bool	$showSource = `true`
	)

static

Log an error message.

Parameters

string	$message	Message to be logged
bool	$showSource	True if the name and line number of the current file are to be included

Returns: void

Definition at line 337 of file Util.php.

    {
        if (self::$logLevel >= self::LOGLEVEL_ERROR) {
            self::log("[ERROR] {$message}", $showSource);
        }
    }

References ILIAS\LTI\ToolProvider\Util\log().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Tool\handleRequest(), ILIAS\LTI\ToolProvider\Http\HttpMessage\send(), ILIAS\LTI\ToolProvider\Jwt\FirebaseClient\sign(), and ILIAS\LTI\ToolProvider\Jwt\FirebaseClient\verify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logForm()

static ILIAS\LTI\ToolProvider\Util::logForm	(	string	$url,
		array	$params,
		string	$method = `'POST'`,
		bool	$debugLevel = `false`
	)

static

Log a form submission.

Parameters

string	$url	URL to which the form should be submitted
array	$params	Array of form parameters
string	$method	HTTP Method used to submit form (optional, default is POST)
bool	$debugLevel	True if the form details should always be logged (optional, default is false to use current log level)

Returns: void

Definition at line 411 of file Util.php.

    {
        if (!$debugLevel) {
            $logLevel = self::$logLevel;
        } else {
            $logLevel = self::LOGLEVEL_DEBUG;
        }
        if (self::$logLevel >= self::LOGLEVEL_INFO) {
            $message = "Form submitted using {$method} to '{$url}'";
            if (!empty($params)) {
                $message .= " with parameters of:\n" . var_export($params, true);
            } else {
                $message .= " with no parameters";
            }
            if ($logLevel < self::LOGLEVEL_DEBUG) {
                self::logInfo($message);
            } else {
                self::logDebug($message);
            }
        }
    }

References ILIAS\LTI\ToolProvider\Util\$logLevel, $message, $params, ILIAS\LTI\ToolProvider\Util\logDebug(), ILIAS\LTI\ToolProvider\Util\logInfo(), and ILIAS\LTI\ToolProvider\Util\LOGLEVEL_DEBUG.

Referenced by ILIAS\LTI\ToolProvider\Util\sendForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logInfo()

static ILIAS\LTI\ToolProvider\Util::logInfo	(	string	$message,
		bool	$showSource = `false`
	)

static

Log an information message.

Parameters

string	$message	Message to be logged
bool	$showSource	True if the name and line number of the current file are to be included

Returns: void

Definition at line 350 of file Util.php.

    {
        if (self::$logLevel >= self::LOGLEVEL_INFO) {
            self::log("[INFO] {$message}", $showSource);
        }
    }

References ILIAS\LTI\ToolProvider\Util\log().

Referenced by ILIAS\LTI\ToolProvider\Tool\checkValue(), ILIAS\LTI\ToolProvider\Util\logForm(), ILIAS\LTI\ToolProvider\Util\logRequest(), and ILIAS\LTI\ToolProvider\Http\HttpMessage\send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logRequest()

static ILIAS\LTI\ToolProvider\Util::logRequest ( bool $debugLevel = false )

static

Log a request received.

Parameters

bool $debugLevel True if the request details should be logged at the debug level (optional, default is false for information level)

Returns: void

Definition at line 375 of file Util.php.

    {
        if (!$debugLevel) {
            $logLevel = self::LOGLEVEL_INFO;
        } else {
            $logLevel = self::LOGLEVEL_DEBUG;
        }
        if (self::$logLevel >= $logLevel) {
            $message = "{$_SERVER['REQUEST_METHOD']} request received for '{$_SERVER['REQUEST_URI']}'";
//            $body = file_get_contents(OAuth\OAuthRequest::$POST_INPUT);
            $body = file_get_contents(LTIOAuth\OAuthRequest::$POST_INPUT);
            if (!empty($body)) {
//                $params = OAuth\OAuthUtil::parse_parameters($body);
                $params = LTIOAuth\OAuthUtil::parse_parameters($body);
                if (!empty($params)) {
                    $message .= " with body parameters of:\n" . var_export($params, true);
                } else {
                    $message .= " with a body of:\n" . var_export($body, true);
                }
            }
            if (!$debugLevel) {
                self::logInfo($message);
            } else {
                self::logDebug($message);
            }
        }
    }

References ILIAS\LTI\ToolProvider\Util\$logLevel, $message, $params, ILIAS\LTI\ToolProvider\Util\logDebug(), ILIAS\LTI\ToolProvider\Util\logInfo(), ILIAS\LTI\ToolProvider\Util\LOGLEVEL_DEBUG, and ILIAS\LTI\ToolProvider\Util\LOGLEVEL_INFO.

Referenced by ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Tool\handleRequest(), and ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logtxt()

static ILIAS\LTI\ToolProvider\Util::logtxt ( string $msg )

static

Definition at line 611 of file Util.php.

    {
        file_put_contents("log.txt", $msg . "\n", FILE_APPEND);
    }

◆ redirect()

static ILIAS\LTI\ToolProvider\Util::redirect	(	string	$url,
		array	$params
	)

static

Redirect to a URL with query parameters.

Parameters

string	$url	URL to which the form should be submitted
array	$params	Array of form parameters

Returns: string

Definition at line 523 of file Util.php.

                                                               : string
    {
        if (!empty($params)) {
            if (strpos($url, '?') === false) {
                $url .= '?';
                $sep = '';
            } else {
                $sep = '&';
            }
            foreach ($params as $key => $value) {
                $key = urlencode($key);
                if (!is_array($value)) {
                    $value = urlencode($value);
                    $url .= "{$sep}{$key}={$value}";
                    $sep = '&';
                } else {
                    foreach ($value as $element) {
                        $element = urlencode($element);
                        $url .= "{$sep}{$key}={$element}";
                        $sep = '&';
                    }
                }
            }
        }
 
        header("Location: {$url}");
        exit;
    }

References ILIAS\LTI\ToolProvider\$key, $params, $url, and exit.

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

Here is the caller graph for this function:

◆ sendForm()

static ILIAS\LTI\ToolProvider\Util::sendForm	(	string	$url,
		array	$params,
		string	$target = `''`
	)

static

Generate a web page containing an auto-submitted form of parameters.

Parameters

string	$url	URL to which the form should be submitted
array	$params	Array of form parameters
string	$target	Name of target (optional)

Returns: string

Definition at line 466 of file Util.php.

                                                                                    : string
    {
        self::logForm($url, $params, 'POST');
        $page = <<< EOD
<html>
<head>
<title>IMS LTI message</title>
<script type="text/javascript">
//<![CDATA[
function doOnLoad() {
    document.forms[0].submit();
}
 
window.onload=doOnLoad;
//]]>
</script>
</head>
<body>
<form action="{$url}" method="post" target="{$target}" encType="application/x-www-form-urlencoded">
 
EOD;
        if (!empty($params)) {
            foreach ($params as $key => $value) {
                $key = htmlentities($key, ENT_COMPAT | ENT_HTML401, 'UTF-8');
                if (!is_array($value)) {
                    $value = htmlentities($value, ENT_COMPAT | ENT_HTML401, 'UTF-8');
                    $page .= <<< EOD
    <input type="hidden" name="{$key}" value="{$value}" />
 
EOD;
                } else {
                    foreach ($value as $element) {
                        $element = htmlentities($element, ENT_COMPAT | ENT_HTML401, 'UTF-8');
                        $page .= <<< EOD
    <input type="hidden" name="{$key}" value="{$element}" />
 
EOD;
                    }
                }
            }
        }
 
        $page .= <<< EOD
</form>
</body>
</html>
EOD;
 
        return $page;
    }

References ILIAS\LTI\ToolProvider\$key, $params, $url, ILIAS\Repository\form(), ILIAS\Repository\html(), and ILIAS\LTI\ToolProvider\Util\logForm().

Referenced by ILIAS\LTI\ToolProvider\Platform\handleAuthenticationRequest(), ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest(), ILIAS\LTI\ToolProvider\sendMessage(), and ILIAS\LTI\ToolProvider\Tool\sendRelaunchRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripHtml()

static ILIAS\LTI\ToolProvider\Util::stripHtml ( string $html )

static

Strip HTML tags from a string.

Parameters

string $html HTML string to be stripped

Returns: string

Definition at line 577 of file Util.php.

                                                  : string
    {
        $html = strip_tags($html);
        $html = html_entity_decode($html, ENT_QUOTES | ENT_HTML401);
 
        return $html;
    }

Field Documentation

◆ $logLevel

int ILIAS\LTI\ToolProvider\Util::$logLevel = self::LOGLEVEL_NONE

static

Current logging level.

Definition at line 189 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\DataConnector\DataConnector\fixPlatformSettings(), ILIAS\LTI\ToolProvider\DataConnector\DataConnector\fixToolSettings(), ILIAS\LTI\ToolProvider\Tool\getMessageParameters(), ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Tool\handleRequest(), ILIAS\LTI\ToolProvider\Util\logForm(), ILIAS\LTI\ToolProvider\Util\logRequest(), ILIAS\LTI\ToolProvider\Http\HttpMessage\send(), and ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest().

◆ $LTI_VERSIONS

array ILIAS\LTI\ToolProvider\Util::$LTI_VERSIONS = array(self::LTI_VERSION1, self::LTI_VERSION1P3, self::LTI_VERSION2)

static

Permitted LTI versions for messages.

Definition at line 161 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\checkMessage().

◆ $METHOD_NAMES

array ILIAS\LTI\ToolProvider\Util::$METHOD_NAMES

static

Initial value:

= array(
        'basic-lti-launch-request' => 'onLaunch',
        'ConfigureLaunchRequest' => 'onConfigure',
        'DashboardRequest' => 'onDashboard',
        'ContentItemSelectionRequest' => 'onContentItem',
        'ContentItemSelection' => 'onContentItem',
        'ContentItemUpdateRequest' => 'onContentItemUpdate',
        'ToolProxyRegistrationRequest' => 'onRegister',
        'LtiStartProctoring' => 'onLtiStartProctoring',
        'LtiStartAssessment' => 'onLtiStartAssessment',
        'LtiEndAssessment' => 'onLtiEndAssessment'
    )

List of supported message types and associated class methods.

Definition at line 166 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\doCallback().

◆ $requestParameters

array ILIAS\LTI\ToolProvider\Util::$requestParameters = null

static

GET and POST request parameters.

Definition at line 182 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Util\getRequestParameters().

◆ JWT_CLAIM_MAPPING

const ILIAS\LTI\ToolProvider\Util::JWT_CLAIM_MAPPING

Mapping for standard message parameters to JWT claim.

Definition at line 58 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\getMessageClaims(), ilObjLTIConsumer\LTISignJWT(), and ILIAS\LTI\ToolProvider\parseClaims().

◆ JWT_CLAIM_PREFIX

const ILIAS\LTI\ToolProvider\Util::JWT_CLAIM_PREFIX = 'https://purl.imsglobal.org/spec/lti'

Prefix for standard JWT message claims.

Definition at line 43 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\addJWTSignature(), ILIAS\LTI\ToolProvider\getMessageClaims(), ILIAS\LTI\ToolProvider\parseClaims(), and ILIAS\LTI\ToolProvider\parseMessage().

◆ LOGLEVEL_DEBUG

const ILIAS\LTI\ToolProvider\Util::LOGLEVEL_DEBUG = 3

Log all messages.

Definition at line 156 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\DataConnector\DataConnector\fixPlatformSettings(), ILIAS\LTI\ToolProvider\DataConnector\DataConnector\fixToolSettings(), ILIAS\LTI\ToolProvider\Tool\getMessageParameters(), ILIAS\LTI\ToolProvider\Platform\handleRequest(), ILIAS\LTI\ToolProvider\Tool\handleRequest(), ILIAS\LTI\ToolProvider\Util\logForm(), and ILIAS\LTI\ToolProvider\Util\logRequest().

◆ LOGLEVEL_ERROR

const ILIAS\LTI\ToolProvider\Util::LOGLEVEL_ERROR = 1

Log errors only.

Definition at line 146 of file Util.php.

◆ LOGLEVEL_INFO

const ILIAS\LTI\ToolProvider\Util::LOGLEVEL_INFO = 2

Log error and information messages.

Definition at line 151 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Util\logRequest(), and ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest().

◆ LOGLEVEL_NONE

const ILIAS\LTI\ToolProvider\Util::LOGLEVEL_NONE = 0

No logging.

Definition at line 141 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Http\HttpMessage\send().

◆ LTI_VERSION1

const ILIAS\LTI\ToolProvider\Util::LTI_VERSION1 = 'LTI-1p0'

LTI version 1 for messages.

Definition at line 28 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\parseRoles(), and ILIAS\LTI\ToolProvider\Tool\result().

◆ LTI_VERSION1P3

const ILIAS\LTI\ToolProvider\Util::LTI_VERSION1P3 = '1.3.0'

LTI version 1.3 for messages.

Definition at line 33 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate(), ILIAS\LTI\ToolProvider\Tool\getPlatformToRegister(), ILIAS\LTI\ToolProvider\signMessage(), and ILIAS\LTI\ToolProvider\Content\Item\toJson().

◆ LTI_VERSION2

const ILIAS\LTI\ToolProvider\Util::LTI_VERSION2 = 'LTI-2p0'

LTI version 2 for messages.

Definition at line 38 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate(), and ILIAS\LTI\ToolProvider\Service\Membership\getMembers().

◆ MESSAGE_TYPE_MAPPING

const ILIAS\LTI\ToolProvider\Util::MESSAGE_TYPE_MAPPING

Initial value:

= array(
        'basic-lti-launch-request' => 'LtiResourceLinkRequest',
        'ContentItemSelectionRequest' => 'LtiDeepLinkingRequest',
        'ContentItemSelection' => 'LtiDeepLinkingResponse',
        'ContentItemUpdateRequest' => 'LtiDeepLinkingUpdateRequest'
    )

Mapping for standard message types.

Definition at line 48 of file Util.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\getConfiguration(), ILIAS\LTI\ToolProvider\getMessageClaims(), and ilObjLTIConsumer\LTISignJWT().

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

Services/LTI/src/ToolProvider/Util.php

Static Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

◆ cloneObject()

◆ getRandomString()

◆ getRequestParameters()

◆ isLtiMessage()

◆ log()

◆ logDebug()

◆ logError()

◆ logForm()

◆ logInfo()

◆ logRequest()

◆ logtxt()

◆ redirect()

◆ sendForm()

◆ stripHtml()

Field Documentation

◆ $logLevel

◆ $LTI_VERSIONS

◆ $METHOD_NAMES

◆ $requestParameters

◆ JWT_CLAIM_MAPPING

◆ JWT_CLAIM_PREFIX

◆ LOGLEVEL_DEBUG

◆ LOGLEVEL_ERROR

◆ LOGLEVEL_INFO

◆ LOGLEVEL_NONE

◆ LTI_VERSION1

◆ LTI_VERSION1P3

◆ LTI_VERSION2

◆ MESSAGE_TYPE_MAPPING