ilLTITool Class Reference

LTI provider for LTI launch. More...

Inheritance diagram for ilLTITool:

Collaboration diagram for ilLTITool:

Public Member Functions
	__construct (ilLTIDataConnector $dataConnector)
	ilLTITool constructor. More...
	parsePostBody (ArrayBasedRequestWrapper $postData)
	handleRequest (bool $strictMode=null, bool $disableCookieCheck=false, bool $generateWarnings=false)

Protected Member Functions
	onLaunch ()
	Process a valid launch request. More...

Protected Attributes
ilLogger	$logger = null

Detailed Description

LTI provider for LTI launch.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de

Definition at line 32 of file class.ilLTITool.php.

Constructor & Destructor Documentation

__construct()

ilLTITool::__construct

(

ilLTIDataConnector

$dataConnector

)

ilLTITool constructor.

Parameters

ilLTIDataConnector

$dataConnector

Definition at line 43 of file class.ilLTITool.php.

References ilLTIDataConnector\getDataConnector(), ilLoggerFactory\getLogger(), and ILIAS\Repository\logger().

    {
        $this->logger = ilLoggerFactory::getLogger('ltis');
        //        $this->initialize();
        if (empty($dataConnector)) {
            $dataConnector = ilLTIDataConnector::getDataConnector();
        }
        $this->dataConnector = $dataConnector;
        //parent::__construct($dataConnector);
        $this->setParameterConstraint('resource_link_id', true, 50, array('basic-lti-launch-request'));
        $this->setParameterConstraint('user_id', true, 64, array('basic-lti-launch-request'));
        $this->setParameterConstraint('roles', true, null, array('basic-lti-launch-request'));
        $this->setParameterConstraint('lis_person_contact_email_primary', true, 80, array('basic-lti-launch-request'));
    }

Here is the call graph for this function:

Member Function Documentation

handleRequest()

ilLTITool::handleRequest	(	bool	$strictMode = null,
		bool	$disableCookieCheck = false,
		bool	$generateWarnings = false
	)

Definition at line 90 of file class.ilLTITool.php.

References $_GET, $_POST, $_SERVER, $DIC, and parsePostBody().

                                                                                                                            : void
    {
        global $DIC;

        $_POST = $this->parsePostBody($DIC->http()->wrapper()->post());
        $_GET = $DIC->http()->request()->getQueryParams();

        if (isset($_POST['lti_version']) && $_POST['lti_version'] === 'LTI-1p0') {
            $_SERVER['REQUEST_URI'] = rtrim(preg_replace('/([?&])client_id=[^&]+(&|$)/', '$1', $_SERVER['REQUEST_URI']), '?&');
        }

        self::$authenticateUsingGet = true;

        parent::handleRequest($strictMode, $disableCookieCheck, $generateWarnings);
    }

Here is the call graph for this function:

onLaunch()

ilLTITool::onLaunch ( )

protected

Process a valid launch request.

Definition at line 61 of file class.ilLTITool.php.

References ILIAS\Repository\logger().

                                 : void
    {
        // save/update current user
        if ($this->userResult instanceof User) {
            $this->logger->debug("onLaunch - user");
            $this->userResult->save();
        }

        if ($this->context instanceof Context) {
            $this->logger->debug("onLaunch - context");
            $this->context->save();
        }

        if ($this->resourceLink instanceof ResourceLink) {
            $this->logger->debug("onLaunch - resource");
            $this->resourceLink->save();
        }
    }

Here is the call graph for this function:

parsePostBody()

ilLTITool::parsePostBody

(

ArrayBasedRequestWrapper

$postData

)

Definition at line 80 of file class.ilLTITool.php.

References $DIC, $res, ILIAS\HTTP\Wrapper\ArrayBasedRequestWrapper\keys(), and ILIAS\HTTP\Wrapper\ArrayBasedRequestWrapper\retrieve().

Referenced by handleRequest().

                                                                     : array
    {
        global $DIC;
        $res = [];
        foreach ($postData->keys() as $key) {
            $res[$key] = $postData->retrieve($key, $DIC->refinery()->kindlyTo()->string());
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logger

ilLogger ilLTITool::$logger = null

protected

Definition at line 37 of file class.ilLTITool.php.

---

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

• components/ILIAS/LTIProvider/classes/InternalProvider/class.ilLTITool.php