ilLTIConsumerEmbeddedContentGUI Class Reference

Collaboration diagram for ilLTIConsumerEmbeddedContentGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object)
	executeCommand ()

Static Public Member Functions
static	isEmbeddedLaunchRequest ()

Data Fields
const	CMD_SHOW_PAGE = 'showPage'
const	CMD_SHOW_EMBEDDED = 'showEmbedded'

Protected Member Functions
	showPage ()
	showEmbedded ()
	getLaunchParameters ()
	initCmixUser ()

Protected Attributes
	$object
	$cmixUser

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLTIConsumerEmbeddedContentGUI::__construct

(

ilObjLTIConsumer

$object

)

Parameters

ilObjLTIConsumer

$object

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

References $object.

    {
        $this->object = $object;
    }

Member Function Documentation

executeCommand()

ilLTIConsumerEmbeddedContentGUI::executeCommand

(

)

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

References $DIC, and ilLTIConsumeProvider\AVAILABILITY_NONE.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if ($this->object->getProvider()->getAvailability() == ilLTIConsumeProvider::AVAILABILITY_NONE) {
            throw new ilLtiConsumerException('access denied!');
        }
        
        $command = $DIC->ctrl()->getCmd(self::CMD_SHOW_PAGE);
        
        $this->{$command}();
    }

getLaunchParameters()

ilLTIConsumerEmbeddedContentGUI::getLaunchParameters ( )

protected

Definition at line 91 of file class.ilLTIConsumerEmbeddedContentGUI.php.

References $DIC, $token, ilCmiXapiAuthToken\fillToken(), ilLTIConsumerLaunch\getContext(), and ilLTIConsumerLaunch\getLTIContextType().

Referenced by showEmbedded().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $ilLTIConsumerLaunch = new ilLTIConsumerLaunch($this->object->getRefId());
        $launchContext = $ilLTIConsumerLaunch->getContext();
        
        $launchContextType = ilLTIConsumerLaunch::getLTIContextType($launchContext["type"]);
        $launchContextId = $launchContext["id"];
        $launchContextTitle = $launchContext["title"];
        
        $token = ilCmiXapiAuthToken::fillToken(
            $DIC->user()->getId(),
            $this->object->getRefId(),
            $this->object->getId()
        );
        
        return $this->object->buildLaunchParameters(
            $this->cmixUser,
            $token,
            $launchContextType,
            $launchContextId,
            $launchContextTitle
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCmixUser()

ilLTIConsumerEmbeddedContentGUI::initCmixUser ( )

protected

Definition at line 132 of file class.ilLTIConsumerEmbeddedContentGUI.php.

References $DIC, ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getUsrIdent().

Referenced by showEmbedded().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $this->cmixUser = new ilCmiXapiUser($this->object->getId(), $DIC->user()->getId(), $this->object->getProvider()->getPrivacyIdent());
        $user_ident = $this->cmixUser->getUsrIdent();
        if ($user_ident == '' || $user_ident == null) {
                        $user_ident = ilCmiXapiUser::getIdent($this->object->getProvider()->getPrivacyIdent(), $DIC->user());
                        $this->cmixUser->setUsrIdent($user_ident);
                        $this->cmixUser->save();
                }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isEmbeddedLaunchRequest()

static ilLTIConsumerEmbeddedContentGUI::isEmbeddedLaunchRequest ( )

static

Definition at line 117 of file class.ilLTIConsumerEmbeddedContentGUI.php.

References $DIC.

Referenced by ilObjLTIConsumerGUI\executeCommand().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if ($DIC->ctrl()->getNextClass() != strtolower(self::class)) {
            return false;
        }
        
        if ($DIC->ctrl()->getCmd() != self::CMD_SHOW_EMBEDDED) {
            return false;
        }
        
        return true;
    }

Here is the caller graph for this function:

showEmbedded()

ilLTIConsumerEmbeddedContentGUI::showEmbedded ( )

protected

Definition at line 64 of file class.ilLTIConsumerEmbeddedContentGUI.php.

References $tpl, exit, ilUtil\getImagePath(), getLaunchParameters(), ILIAS_VERSION_NUMERIC, and initCmixUser().

    {
        $this->initCmixUser();
        
        $tpl = new ilTemplate('tpl.lti_embedded.html', true, true, 'Modules/LTIConsumer');
        
        foreach ($this->getLaunchParameters() as $field => $value) {
            $tpl->setCurrentBlock('launch_parameter');
            $tpl->setVariable('LAUNCH_PARAMETER', $field);
            $tpl->setVariable('LAUNCH_PARAM_VALUE', $value);
            $tpl->parseCurrentBlock();
        }
        
        $v = DEVMODE ? '?vers=' . time() : '?vers=' . ILIAS_VERSION_NUMERIC;
        $tpl->setVariable("DELOS_CSS_HREF", 'templates/default/delos.css' . $v);
        $tpl->setVariable("JQUERY_SRC", 'libs/bower/bower_components/jquery/dist/jquery.js' . $v);
        
        $tpl->setVariable("LOADER_ICON_SRC", ilUtil::getImagePath("loader.svg"));
        $tpl->setVariable('LAUNCH_URL', $this->object->getProvider()->getProviderUrl());
        
        #$DIC->ui()->mainTemplate()->getStandardTemplate();
        #$DIC->ui()->mainTemplate()->setContent($tpl->get());
        
        echo $tpl->get();
        exit;
    }

Here is the call graph for this function:

showPage()

ilLTIConsumerEmbeddedContentGUI::showPage ( )

protected

Definition at line 50 of file class.ilLTIConsumerEmbeddedContentGUI.php.

References $DIC, and $tpl.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $tpl = new ilTemplate('tpl.lti_content.html', true, true, 'Modules/LTIConsumer');
        
        $tpl->setVariable("EMBEDDED_IFRAME_SRC", $DIC->ctrl()->getLinkTarget(
            $this,
            self::CMD_SHOW_EMBEDDED
        ));
        
        $DIC->ui()->mainTemplate()->setContent($tpl->get());
    }

Field Documentation

$cmixUser

ilLTIConsumerEmbeddedContentGUI::$cmixUser

protected

Definition at line 27 of file class.ilLTIConsumerEmbeddedContentGUI.php.

$object

ilLTIConsumerEmbeddedContentGUI::$object

protected

Definition at line 22 of file class.ilLTIConsumerEmbeddedContentGUI.php.

Referenced by __construct().

CMD_SHOW_EMBEDDED

const ilLTIConsumerEmbeddedContentGUI::CMD_SHOW_EMBEDDED = 'showEmbedded'

Definition at line 17 of file class.ilLTIConsumerEmbeddedContentGUI.php.

CMD_SHOW_PAGE

const ilLTIConsumerEmbeddedContentGUI::CMD_SHOW_PAGE = 'showPage'

Definition at line 16 of file class.ilLTIConsumerEmbeddedContentGUI.php.

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerEmbeddedContentGUI.php