Collaboration diagram for ilLTIConsumerLaunch:

Public Member Functions
	__construct (int $a_ref_id)
	ilObjLTIConsumerLaunch constructor. More...

	getContext ($a_valid_types=array('crs', 'grp', 'cat', 'root'))
	get info about the context in which the link is used More...

Static Public Member Functions
static	getLTIContextType ($a_type)

static	signOAuth ($a_params)
	sign request data with OAuth More...

Protected Attributes
	$ref_id

Static Private Attributes
static	$last_oauth_base_string = ""

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerLaunch::__construct ( int $a_ref_id )

ilObjLTIConsumerLaunch constructor.

Parameters

int	$a_id
bool	$a_reference

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

    {
        $this->ref_id = $a_ref_id;
    }

Member Function Documentation

◆ getContext()

ilLTIConsumerLaunch::getContext ( $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 list of valid types

Returns: array context array ("ref_id", "title", "type")

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

    {
        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 $key => $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, and $DIC.

◆ getLTIContextType()

static ilLTIConsumerLaunch::getLTIContextType ( $a_type )

static

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

    {
        switch ($a_type) {
            case "crs":
                return "CourseOffering";
                break;
            case "grp":
                return "Group";
                break;
            case "root":
                return "urn:lti:context-type:ilias/RootNode";
                break;
            case "cat":
            default:
                return "urn:lti:context-type:ilias/Category";
                break;
        }
    }

References $a_type.

Referenced by ilLTIConsumerEmbeddedContentGUI\getLaunchParameters().

Here is the caller graph for this function:

◆ signOAuth()

static ilLTIConsumerLaunch::signOAuth ( $a_params )

static

sign request data with OAuth

Parameters

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

Returns: array signed data

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

    {
        require_once('./Modules/LTIConsumer/lib/OAuth.php');
        switch ($a_params['sign_method']) {
            case "HMAC_SHA1":
                $method = new OAuthSignatureMethod_HMAC_SHA1();
                break;
            case "PLAINTEXT":
                $method = new OAuthSignatureMethod_PLAINTEXT();
                break;
            case "RSA_SHA1":
                $method = new OAuthSignatureMethod_RSA_SHA1();
                break;
                
            default:
                return "ERROR: unsupported signature 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();
    }