ilLTIConsumerLaunch Class Reference

Collaboration diagram for ilLTIConsumerLaunch:

Public Member Functions
	__construct (int $a_ref_id)
	ilObjLTIConsumerLaunch constructor. More...
	getContext (?array $a_valid_types=array('crs', 'grp', 'cat', 'root'))
	get info about the context in which the link is used The most outer matching course or group is used If not found the most inner category or root node is used More...

Static Public Member Functions
static	getLTIContextType (string $a_type)
static	signOAuth (array $a_params)
	sign request data with OAuth More...

Protected Attributes
int	$ref_id

Private Attributes
array	$context = null

Detailed Description

Definition at line 33 of file class.ilLTIConsumerLaunch.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerLaunch::__construct

(

int

$a_ref_id

)

ilObjLTIConsumerLaunch constructor.

Definition at line 41 of file class.ilLTIConsumerLaunch.php.

    {
        $this->ref_id = $a_ref_id;
    }

Member Function Documentation

getContext()

ilLTIConsumerLaunch::getContext

(

?array

$a_valid_types = array('crs', 'grp', 'cat', 'root')

)

get info about the context in which the link is used The most outer matching course or group is used If not found the most inner category or root node is used

Parameters

array | null

$a_valid_types

list of valid types

Returns

array|null context array ("ref_id", "title", "type")

Definition at line 54 of file class.ilLTIConsumerLaunch.php.

                                                                                          : ?array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $tree = $DIC->repositoryTree();
 
        if (!isset($this->context)) {
            $this->context = array();
 
            // check fromm inner to outer
            $path = array_reverse($tree->getPathFull($this->ref_id));
            foreach ($path as $row) {
                if (in_array($row['type'], $a_valid_types)) {
                    // take an existing inner context outside a course
                    if (in_array($row['type'], array('cat', 'root')) && !empty($this->context)) {
                        break;
                    }
 
                    $this->context['id'] = $row['child'];
                    $this->context['title'] = $row['title'];
                    $this->context['type'] = $row['type'];
 
                    // don't break to get the most outer course or group
                }
            }
        }
        return $this->context;
    }

References $context, $DIC, and $path.

getLTIContextType()

static ilLTIConsumerLaunch::getLTIContextType ( string  $a_type )

static

Definition at line 85 of file class.ilLTIConsumerLaunch.php.

                                                            : string
    {
        switch ($a_type) {
            case "crs":
                return "http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering";
            case "grp":
                return "http://purl.imsglobal.org/vocab/lis/v2/course#Group";
            case "root":
                return "http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering";
            case "cat":
            default:
                return "http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering";
        }
    }

Referenced by ilLTIConsumerContentGUI\getLaunchParameters(), and ilLTIConsumerContentGUI\getLaunchParametersLTI13().

Here is the caller graph for this function:

signOAuth()

static ilLTIConsumerLaunch::signOAuth ( array  $a_params )

static

sign request data with OAuth

Parameters

array

$a_params

( "method => signature methos "key" => consumer key "secret" => shared secret "token" => request token "url" => request url data => array (key => value) )

Returns

array signed data

Exceptions

Exception

Definition at line 115 of file class.ilLTIConsumerLaunch.php.

                                                     : array
    {
        switch ($a_params['sign_method']) {
            case "HMAC_SHA1":
                $method = new OAuthSignatureMethod_HMAC_SHA1();
                break;
            default:
                throw new Exception("Unknown signature method: " . $a_params['sign_method']);
        }
 
        $consumer = new OAuthConsumer($a_params["key"], $a_params["secret"], $a_params["callback"]);
        $request = OAuthRequest::from_consumer_and_token($consumer, $a_params["token"], $a_params["http_method"], $a_params["url"], $a_params["data"]);
        $request->sign_request($method, $consumer, $a_params["token"]);
 
        // Pass this back up "out of band" for debugging
        //        self::$last_oauth_base_string = $request->get_signature_base_string();
        // die(self::$last_oauth_base_string);
 
        return $request->get_parameters();
    }

Field Documentation

$context

array ilLTIConsumerLaunch::$context = null

private

Definition at line 35 of file class.ilLTIConsumerLaunch.php.

Referenced by getContext().

$ref_id

int ilLTIConsumerLaunch::$ref_id

protected

Definition at line 36 of file class.ilLTIConsumerLaunch.php.

---

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

• components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerLaunch.php