Collaboration diagram for ilLTIConsumerContentGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object)

	executeCommand ()

Static Public Member Functions
static	isEmbeddedLaunchRequest ()

Data Fields
const	CMD_LAUNCH = 'launch'

const	CMD_SHOW_EMBEDDED = 'showEmbedded'

Protected Member Functions
	launch ()

	getStartButtonTxt11 ()

	showEmbedded ()

	getLaunchParameters ()

	initCmixUser ()

Protected Attributes
	$object

	$cmixUser

Private Attributes
	$dic

	$lng

	$user

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerContentGUI::__construct ( ilObjLTIConsumer $object )

Parameters

ilObjLTIConsumer $object

Definition at line 46 of file class.ilLTIConsumerContentGUI.php.

References $DIC, $object, and user().

     {
         global $DIC;
         $this->dic = $DIC;
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->object = $object;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLTIConsumerContentGUI::executeCommand ( )

Definition at line 55 of file class.ilLTIConsumerContentGUI.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_LAUNCH);
         
         $this->{$command}();
     }

◆ getLaunchParameters()

ilLTIConsumerContentGUI::getLaunchParameters ( )

protected

Definition at line 192 of file class.ilLTIConsumerContentGUI.php.

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

Referenced by showEmbedded().

     {
         $ilLTIConsumerLaunch = new ilLTIConsumerLaunch($this->object->getRefId());
         $launchContext = $ilLTIConsumerLaunch->getContext();
         
         $launchContextType = ilLTIConsumerLaunch::getLTIContextType($launchContext["type"]);
         $launchContextId = $launchContext["id"];
         $launchContextTitle = $launchContext["title"];
         
         $token = ilCmiXapiAuthToken::fillToken(
             $this->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:

◆ getStartButtonTxt11()

ilLTIConsumerContentGUI::getStartButtonTxt11 ( )

protected

Definition at line 102 of file class.ilLTIConsumerContentGUI.php.

References $cmixUser, $context, $token, ilLTIConsumeProvider\AVAILABILITY_NONE, ilCmiXapiAuthToken\fillToken(), ilCmiXapiUser\getIdent(), and user().

Referenced by launch().

                                              : string
     {
         if ($this->object->getOfflineStatus() ||
             $this->object->isLaunchMethodEmbedded() ||
             $this->object->getProvider()->getAvailability() == ilLTIConsumeProvider::AVAILABILITY_NONE) {
             return "";
         }
 
         $cmixUser = new ilCmiXapiUser(
             $this->object->getId(),
             $this->user->getId(),
             $this->object->getProvider()->getPrivacyIdent()
         );
         $user_ident = $cmixUser->getUsrIdent();
         if ($user_ident == '' || $user_ident == null) {
             $user_ident = ilCmiXapiUser::getIdent($this->object->getProvider()->getPrivacyIdent(), $this->dic->user());
             $cmixUser->setUsrIdent($user_ident);
             $cmixUser->save();
         }
         $ilLTIConsumerLaunch = new ilLTIConsumerLaunch($this->object->getRefId());
         $context = $ilLTIConsumerLaunch->getContext();
         $contextType = $ilLTIConsumerLaunch::getLTIContextType($context["type"]);
         $contextId = $context["id"];
         $contextTitle = $context["title"];
 
         $token = ilCmiXapiAuthToken::fillToken(
             $this->dic->user()->getId(),
             $this->object->getRefId(),
             $this->object->getId()
         );
 
         $returnUrl = !$this->object->isLaunchMethodOwnWin() ? '' : str_replace(
             '&amp;',
             '&',
             ILIAS_HTTP_PATH . "/" . $this->dic->ctrl()->getLinkTarget($this, "", "", false)
         );
 
         $launchParameters = $this->object->buildLaunchParameters(
             $cmixUser,
             $token,
             $contextType,
             $contextId,
             $contextTitle,
             $returnUrl
         );
 
         $target = $this->object->getLaunchMethod() == "newWin" ? "_blank" : "_self";
         $button = '<input class="btn btn-default ilPre" type="button" onClick="ltilaunch()" value = "' . $this->lng->txt("show_content") . '" />';
         $output = '<form id="lti_launch_form" name="lti_launch_form" action="' . $this->object->getProvider()->getProviderUrl() . '" method="post" target="' . $target . '" encType="application/x-www-form-urlencoded">';
         foreach ($launchParameters as $field => $value) {
             $output .= sprintf('<input type="hidden" name="%s" value="%s" />', $field, $value) . "\n";
         }
         $output .= $button;
         $output .= '</form>';
         $output .= '<span id ="lti_launched" style="display:none">' . $this->lng->txt("launched") . '</span>';
         $output .= '<script type="text/javascript">
         function ltilaunch() {
             document.lti_launch_form.submit();
             document.getElementById("lti_launch_form").style.display = "none";
             document.getElementById("lti_launched").style.display = "inline";
         }</script>';
         return($output);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCmixUser()

ilLTIConsumerContentGUI::initCmixUser ( )

protected

Definition at line 231 of file class.ilLTIConsumerContentGUI.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 ilLTIConsumerContentGUI::isEmbeddedLaunchRequest ( )

static

Definition at line 216 of file class.ilLTIConsumerContentGUI.php.

References $DIC.

Referenced by ilObjLTIConsumerGUI\executeCommand().

                                                      : bool
     {
         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:

◆ launch()

ilLTIConsumerContentGUI::launch ( )

protected

Exceptions

ilCtrlException
ilTemplateException

Definition at line 86 of file class.ilLTIConsumerContentGUI.php.

References $tpl, and getStartButtonTxt11().

                                 : void
     {
         if ($this->dic->access()->checkAccess('read', '', $this->object->getRefId())) {
             if ($this->object->isLaunchMethodEmbedded()) {
                 $tpl = new ilTemplate('tpl.lti_content.html', true, true, 'Modules/LTIConsumer');
                 $tpl->setVariable("EMBEDDED_IFRAME_SRC", $this->dic->ctrl()->getLinkTarget(
                     $this,
                     self::CMD_SHOW_EMBEDDED
                 ));
                 $this->dic->ui()->mainTemplate()->setContent($tpl->get());
             } else {
                 $this->dic->toolbar()->addText($this->getStartButtonTxt11());
             }
         }
     }

Here is the call graph for this function:

◆ showEmbedded()

ilLTIConsumerContentGUI::showEmbedded ( )

protected

Definition at line 165 of file class.ilLTIConsumerContentGUI.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;
     }