Inheritance diagram for ilObjLTIConsumerGUI:

Collaboration diagram for ilObjLTIConsumerGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)

	getType ()

	initCreationForms ($a_new_type)

	initCreateForm ($a_new_type)

	initCustomCreateForm ($a_new_type)

	saveCustom ()

	afterSave (ilObject $newObject)

	initMetadata (ilObjLTIConsumer $object)

	executeCommand ()

	setTabs ()

	addLocatorItems ()

Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	executeCommand ()
	execute command More...

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode ($a_mode=true)

	getCreationMode ()

	prepareOutput ($a_show_subobjects=true)

	isVisible ($a_ref_id, $a_type)

	trash ()

	undelete ()

	cancelDelete ()

	removeFromSystem ()

	cloneAll ()

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	Deleted in ilObject. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()
	Import. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page public More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()
	save object More...

	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto ($a_target)

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
const	CFORM_CUSTOM_NEW = 99

const	TAB_ID_INFO = 'tab_info'

const	TAB_ID_CONTENT = 'tab_content'

const	TAB_ID_SETTINGS = 'tab_settings'

const	TAB_ID_STATEMENTS = 'tab_statements'

const	TAB_ID_SCORING = 'tab_scoring'

const	TAB_ID_METADATA = 'tab_metadata'

const	TAB_ID_LEARNING_PROGRESS = 'learning_progress'

const	TAB_ID_PERMISSIONS = 'perm_settings'

const	DEFAULT_CMD = 'launch'

	$object

Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	buildProviderSelectionForm ($a_new_type)

	applyProviderFilter ()

	resetProviderFilter ()

	createNewObject ($newType, $title, $description)

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)

	debug ()

	trackObjectReadEvent ()

	infoScreen ()

	infoScreenForward ()

	handleAvailablityMessage ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()
	Get access handler. More...

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...

	setTitleAndDescription ()

	showUpperIcon ()

	omitLocator ($a_omit=true)

	getTargetFrame ($a_cmd, $a_target_frame="")

	setTargetFrame ($a_cmd, $a_target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	setColumnSettings (ilColumnGUI $column_gui)

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId ($a_ref_id, $a_cmd="")

	fillCloneTemplate ($a_tpl_varname, $a_type)

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

	addAdminLocatorItems ($a_do_not_add_object=false)

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...

	setReturnLocation ($a_cmd, $a_location)

	showActions ()

	getTabs ()

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

	getPermanentLinkWidget ($a_append=null, $a_center=false)

	handleAutoRating (ilObject $a_new_obj)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs public More...

	setAdminTabs ()
	set admin tabs public More...

	setLocator ()
	set Locator More...

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator ($a_omit=true)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditForm ()
	Init object edit form. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()
	Get values for edit form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$ltiAccess

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

	$ilErr

	$locator

	$user

	$access

	$rbacsystem

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

	$favourites

	$request

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjLTIConsumerGUI::__construct	(	$a_id = `0`,
		$a_id_type = `self::REPOSITORY_NODE_ID`,
		$a_parent_node_id = `0`
	)

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
         
         if ($this->object instanceof ilObjLTIConsumer) {
             $this->ltiAccess = new ilLTIConsumerAccess($this->object);
         }
         
         $DIC->language()->loadLanguageModule("lti");
         $DIC->language()->loadLanguageModule("rep");
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjLTIConsumerGUI::_goto ( $a_target )

static

Definition at line 353 of file class.ilObjLTIConsumerGUI.php.

References ilObjectGUI\$access, ilObjectGUI\$ctrl, $DIC, ilObjectGUI\$lng, ilObjectGUI\$request, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ROOT_FOLDER_ID, and ilUtil\sendInfo().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $err = $DIC['ilErr']; /* @var ilErrorHandling $err */
         $ctrl = $DIC->ctrl();
         $request = $DIC->http()->request();
         $access = $DIC->access();
         $lng = $DIC->language();
 
         $targetParameters = explode('_', $a_target);
         $id = (int) $targetParameters[0];
 
         if ($id <= 0) {
             $err->raiseError($lng->txt('msg_no_perm_read'), $err->FATAL);
         }
 
         if ($access->checkAccess('read', '', $id)) {
             $ctrl->setTargetScript('ilias.php');
             $ctrl->initBaseClass(ilRepositoryGUI::class);
             $ctrl->setParameterByClass(ilObjLTIConsumerGUI::class, 'ref_id', $id);
             if (isset($request->getQueryParams()['gotolp'])) {
                 $ctrl->setParameterByClass(ilObjLTIConsumerGUI::class, 'gotolp', 1);
             }
             $ctrl->redirectByClass([ilRepositoryGUI::class, ilObjLTIConsumerGUI::class]);
         } elseif ($access->checkAccess('visible', '', $id)) {
             ilObjectGUI::_gotoRepositoryNode($id, 'infoScreen');
         } elseif ($access->checkAccess('read', '', ROOT_FOLDER_ID)) {
             ilUtil::sendInfo(
                 sprintf(
                     $DIC->language()->txt('msg_no_perm_read_item'),
                     ilObject::_lookupTitle(ilObject::_lookupObjId($id))
                 ),
                 true
             );
             
             ilObjectGUI::_gotoRepositoryRoot();
         }
         
         $err->raiseError($DIC->language()->txt("msg_no_perm_read_lm"), $err->FATAL);
     }

Here is the call graph for this function:

◆ addLocatorItems()

ilObjLTIConsumerGUI::addLocatorItems ( )

Definition at line 659 of file class.ilObjLTIConsumerGUI.php.

References $_GET, $DIC, and ilObjectGUI\$locator.

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $locator = $DIC['ilLocator']; /* @var ilLocatorGUI $locator */
         $locator->addItem(
             $this->object->getTitle(),
             $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD),
             "",
             $_GET["ref_id"]
         );
     }

◆ afterSave()

ilObjLTIConsumerGUI::afterSave ( ilObject $newObject )

Definition at line 246 of file class.ilObjLTIConsumerGUI.php.

References $_GET, $DIC, ilLTIConsumeProvider\AVAILABILITY_CREATE, ilObject\getTitle(), ilObject\getType(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), initCustomCreateForm(), initMetadata(), ilObject\setTitle(), and ilObject\update().

Referenced by saveCustom().

     {
         /* @var ilObjLTIConsumer $newObject */
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         if (isset($_GET['provider_id']) && (int) $_GET['provider_id']) {
             $newObject->setProviderId((int) $_GET['provider_id']);
             $newObject->initProvider();
             $newObject->save();
             
             $newObject->setTitle($newObject->getProvider()->getTitle());
             $newObject->setMasteryScore($newObject->getProvider()->getMasteryScore());
             $newObject->update();
             
             $this->initMetadata($newObject);
             
             $DIC->ctrl()->redirectByClass(ilLTIConsumerSettingsGUI::class);
         }
         
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         
         $form = $this->initCustomCreateForm($newObject->getType());
         
         if ($form->checkInput()) {
             $provider = new ilLTIConsumeProvider();
             $form->initProvider($provider);
             $provider->setAvailability(ilLTIConsumeProvider::AVAILABILITY_CREATE);
             $provider->setIsGlobal(false);
             $provider->setCreator($DIC->user()->getId());
             $provider->save();
             
             $newObject->setProviderId($provider->getId());
             $newObject->setProvider($provider);
             $newObject->save();
             
             $newObject->setTitle($provider->getTitle());
             $newObject->setMasteryScore($newObject->getProvider()->getMasteryScore());
             $newObject->update();
             
             $this->initMetadata($newObject);
             
             $DIC->ctrl()->redirectByClass(ilObjLTIConsumerGUI::class);
         }
         
         throw new ilLtiConsumerException(
             'form validation seems to not have worked in ilObjLTIConsumer::saveCustom()!'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyProviderFilter()

ilObjLTIConsumerGUI::applyProviderFilter ( )

protected

Definition at line 173 of file class.ilObjLTIConsumerGUI.php.

References buildProviderSelectionForm(), and ilObjectGUI\createObject().

     {
         $form = $this->buildProviderSelectionForm('');
         $form->applyFilter();
         $this->createObject();
     }

Here is the call graph for this function:

◆ buildProviderSelectionForm()

ilObjLTIConsumerGUI::buildProviderSelectionForm ( $a_new_type )

protected

Definition at line 162 of file class.ilObjLTIConsumerGUI.php.

Referenced by applyProviderFilter(), initCreateForm(), and resetProviderFilter().

     {
         return new ilLTIConsumerProviderSelectionFormTableGUI(
             $a_new_type,
             $this,
             'create',
             'applyProviderFilter',
             'resetProviderFilter'
         );
     }

Here is the caller graph for this function:

◆ createNewObject()

ilObjLTIConsumerGUI::createNewObject	(	$newType,
		$title,
		$description
	)

protected

Definition at line 187 of file class.ilObjLTIConsumerGUI.php.

References ilObject2GUI\putObjectInTree().

Referenced by saveCustom().

     {
         $classname = "ilObj" . $this->objDefinition->getClassName($newType);
 
         $newObj = new $classname();
         $newObj->setType($newType);
         $newObj->setTitle($title);
         $newObj->setDescription($description);
         $newObj->create();
         
         $this->putObjectInTree($newObj);
         
         return $newObj;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ debug()

ilObjLTIConsumerGUI::debug ( )

protected

Definition at line 613 of file class.ilObjLTIConsumerGUI.php.

References $DIC, Vendor\Package\$e, ilObjectGUI\$request, ilCmiXapiLrsType\buildBasicAuth(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\sendQuestion().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $DIC->tabs()->activateTab('debug');
         
         $filter = new ilCmiXapiStatementsReportFilter();
         $filter->setActivityId($this->object->getActivityId());
         
         $aggregateEndPointUrl = str_replace(
             'data/xAPI',
             'api/statements/aggregate',
             $this->object->getProvider()->getXapiLaunchUrl() // should be named endpoint not launch url
         );
         
         $linkBuilder = new ilCmiXapiHighscoreReportLinkBuilder(
             $this->object,
             $aggregateEndPointUrl,
             $filter
         );
         
         $basicAuth = ilCmiXapiLrsType::buildBasicAuth(
             $this->object->getProvider()->getXapiLaunchKey(),
             $this->object->getProvider()->getXapiLaunchSecret()
         );
         
         $request = new ilCmiXapiHighscoreReportRequest(
             $basicAuth,
             $linkBuilder
         );
         
         try {
             $report = $request->queryReport($this->object);
             
             $DIC->ui()->mainTemplate()->setContent(
                 $report->getResponseDebug()
             );
             
             //ilUtil::sendSuccess('Object ID: '.$this->object->getId());
             ilUtil::sendInfo($linkBuilder->getPipelineDebug());
             ilUtil::sendQuestion('<pre>' . print_r($report->getTableData(), 1) . '</pre>');
         } catch (Exception $e) {
             ilUtil::sendFailure($e->getMessage());
         }
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjLTIConsumerGUI::executeCommand ( )

Exceptions

ilCtrlException

Definition at line 397 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilLink\_getLink(), ilObjectGUI\addHeaderAction(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getType(), infoScreen(), ilLTIConsumerContentGUI\isEmbeddedLaunchRequest(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObject2GUI\prepareOutput(), and trackObjectReadEvent().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         // TODO: general access checks (!)
 
         if (!ilLTIConsumerContentGUI::isEmbeddedLaunchRequest()) {
             $this->prepareOutput();
             $this->addHeaderAction();
         }
         
         if (!$this->creation_mode) {
             $this->trackObjectReadEvent();
             
             if ($this->object->getProvider()->hasProviderIcon()) {
                 $DIC->ui()->mainTemplate()->setTitleIcon(
                     $this->object->getProvider()->getProviderIcon()->getAbsoluteFilePath(),
                     'Icon ' . $this->object->getProvider()->getTitle()
                 );
             }
             
             $link = ilLink::_getLink($this->object->getRefId(), $this->object->getType());
             $navigationHistory = $DIC['ilNavigationHistory']; /* @var ilNavigationHistory $navigationHistory */
             $navigationHistory->addItem($this->object->getRefId(), $link, $this->object->getType());
         }
         
         switch ($DIC->ctrl()->getNextClass()) {
             case strtolower(ilObjectCopyGUI::class):
                 
                 $gui = new ilObjectCopyGUI($this);
                 $gui->setType($this->getType());
                 $DIC->ctrl()->forwardCommand($gui);
                 break;
 
             case strtolower(ilCommonActionDispatcherGUI::class):
                 
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $DIC->ctrl()->forwardCommand($gui);
                 break;
             
             case strtolower(ilLearningProgressGUI::class):
                 
                 $DIC->tabs()->activateTab(self::TAB_ID_LEARNING_PROGRESS);
                 
                 $gui = new ilLearningProgressGUI(
                     ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                     $this->object->getRefId()
                 );
                 
                 $DIC->ctrl()->forwardCommand($gui);
                 
                 break;
                 
             case strtolower(ilObjectMetaDataGUI::class):
 
                 if (!$DIC->access()->checkAccess('write', '', $this->object->getRefId())) {
                     $DIC['ilErr']->raiseError($DIC->language()->txt("msg_no_perm_write"));
                 } else {
                     $DIC->tabs()->activateTab(self::TAB_ID_METADATA);
 
                     $gui = new ilObjectMetaDataGUI($this->object);
                     $DIC->ctrl()->forwardCommand($gui);
                 }
                 break;
             
             case strtolower(ilPermissionGUI::class):
                 
                 $DIC->tabs()->activateTab(self::TAB_ID_PERMISSIONS);
                 
                 $gui = new ilPermissionGUI($this);
                 $DIC->ctrl()->forwardCommand($gui);
                 break;
                 
             case strtolower(ilLTIConsumerSettingsGUI::class):
 
                 if (!$DIC->access()->checkAccess('write', '', $this->object->getRefId())) {
                     $DIC['ilErr']->raiseError($DIC->language()->txt("msg_no_perm_write"));
                 } else {
                     $DIC->tabs()->activateTab(self::TAB_ID_SETTINGS);
 
                     $gui = new ilLTIConsumerSettingsGUI($this->object, $this->ltiAccess);
                     $DIC->ctrl()->forwardCommand($gui);
                 }
                 break;
             
             case strtolower(ilLTIConsumerXapiStatementsGUI::class):
                 
                 $DIC->tabs()->activateTab(self::TAB_ID_STATEMENTS);
                 
                 $gui = new ilLTIConsumerXapiStatementsGUI($this->object);
                 $DIC->ctrl()->forwardCommand($gui);
                 
                 break;
             
             case strtolower(ilLTIConsumerScoringGUI::class):
 
                 $DIC->tabs()->activateTab(self::TAB_ID_SCORING);
 
                 $gui = new ilLTIConsumerScoringGUI($this->object);
                 $DIC->ctrl()->forwardCommand($gui);
 
                 break;
             
             case strtolower(ilLTIConsumerContentGUI::class):
 
                 if (!$DIC->access()->checkAccess('read', '', $this->object->getRefId())) {
                     $DIC['ilErr']->raiseError($DIC->language()->txt("msg_no_perm_read"));
                 } else {
                     $DIC->tabs()->activateTab(self::TAB_ID_CONTENT);
 
                     $gui = new ilLTIConsumerContentGUI($this->object);
                     $DIC->ctrl()->forwardCommand($gui);
                 }
 
                 break;
 
             case strtolower(ilInfoScreenGUI::class):
 
                 $DIC->tabs()->activateTab(self::TAB_ID_INFO);
                 $this->infoScreen();
 
                 break;
 
             default:
                 $command = $DIC->ctrl()->getCmd(self::DEFAULT_CMD);
                 $this->{$command}();
         }
     }

Here is the call graph for this function:

◆ getType()

ilObjLTIConsumerGUI::getType ( )

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

Referenced by executeCommand().

     {
         return 'lti';
     }

Here is the caller graph for this function:

◆ handleAvailablityMessage()

ilObjLTIConsumerGUI::handleAvailablityMessage ( )

protected

Definition at line 791 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilLTIConsumeProvider\AVAILABILITY_NONE, and ilUtil\sendFailure().

Referenced by infoScreenForward().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         if ($this->object->getProvider()->getProviderUrl() == '') {
             ilUtil::sendFailure($DIC->language()->txt('lti_provider_not_set_msg'));
         } elseif ($this->object->getProvider()->getAvailability() == ilLTIConsumeProvider::AVAILABILITY_NONE) {
             ilUtil::sendFailure($DIC->language()->txt('lti_provider_not_avail_msg'));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreen()

ilObjLTIConsumerGUI::infoScreen ( )

protected

Definition at line 695 of file class.ilObjLTIConsumerGUI.php.

References $DIC, and infoScreenForward().

Referenced by executeCommand().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $DIC->tabs()->activateTab(self::TAB_ID_INFO);
         
         $DIC->ctrl()->setCmd("showSummary");
         $DIC->ctrl()->setCmdClass("ilinfoscreengui");
         $this->infoScreenForward();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreenForward()

ilObjLTIConsumerGUI::infoScreenForward ( )

protected

Definition at line 706 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilObjectGUI\$ilErr, ilLPObjSettings\_lookupDBMode(), ilObject2GUI\checkPermissionBool(), ilObjCmiXapiGUI\getPrivacyIdentString(), ilObjCmiXapiGUI\getPrivacyNameString(), and handleAvailablityMessage().

Referenced by infoScreen().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $ilErr = $DIC['ilErr']; /* @var ilErrorHandling $ilErr */
         
         if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
             $ilErr->raiseError($DIC->language()->txt("msg_no_perm_read"));
         }
         
         $this->handleAvailablityMessage();
 
         $info = new ilInfoScreenGUI($this);
         
         $info->enablePrivateNotes();
         
         if ($this->checkPermissionBool("read")) {
             $info->enableNews();
         }
         
         $info->enableNewsEditing(false);
 
         if ($this->checkPermissionBool("write")) {
             $news_set = new ilSetting("news");
             $enable_internal_rss = $news_set->get("enable_rss_for_internal");
             
             if ($enable_internal_rss) {
                 $info->setBlockProperty("news", "settings", true);
                 $info->setBlockProperty("news", "public_notifications_option", true);
             }
         }
         
         // standard meta data
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
         
         if (DEVMODE) {
             // Development Info
             $info->addSection('DEVMODE Info');
             $info->addProperty('Local Object ID', $this->object->getId());
             $info->addProperty('Current User ID', $DIC->user()->getId());
         }
 
         require_once('Services/Tracking/classes/class.ilLPObjSettings.php');
         if ($this->object->getProvider()->getHasOutcome() && ilLPObjSettings::_lookupDBMode($this->object->getId()) != 0) {
             $info->addSection($DIC->language()->txt("lti_info_learning_progress_section"));
             $info->addProperty(
                 $DIC->language()->txt("mastery_score"),
                 ($this->object->getMasteryScorePercent()) . ' %'
             );
         }
 
         // LTI Ressource Info about privacy
         $info->addSection($DIC->language()->txt("lti_info_privacy_section"));
 
         $info->addProperty(
             $DIC->language()->txt("lti_con_prov_url"),
             $this->object->getProvider()->getProviderUrl()
         );
 
         $info->addProperty(
             $DIC->language()->txt("conf_privacy_name"),
             $DIC->language()->txt('conf_privacy_name_' . ilObjCmiXapiGUI::getPrivacyNameString($this->object->getProvider()->getPrivacyName()))
         );
 
         $info->addProperty(
             $DIC->language()->txt("conf_privacy_ident"),
             $DIC->language()->txt('conf_privacy_ident_' . ilObjCmiXapiGUI::getPrivacyIdentString($this->object->getProvider()->getPrivacyIdent()))
         );
         if ($this->object->getProvider()->isExternalProvider()) {
             $info->addProperty(
                 $DIC->language()->txt("lti_info_external_provider_label"),
                 $DIC->language()->txt('lti_info_external_provider_info')
             );
         }
 
         if ($this->object->getProvider()->getUseXapi()) {
             $info->addProperty(
                 $DIC->language()->txt("lti_con_prov_xapi_launch_url"),
                 $this->object->getProvider()->getXapiLaunchUrl()
             );
         }
 
         // FINISHED INFO SCREEN, NOW FORWARD
         $this->ctrl->forwardCommand($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjLTIConsumerGUI::initCreateForm ( $a_new_type )

Definition at line 87 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilLTIConsumeProvider\AVAILABILITY_CREATE, buildProviderSelectionForm(), ilLTIConsumeProviderList\SCOPE_GLOBAL, and ilLTIConsumeProviderList\SCOPE_USER.

Referenced by initCreationForms().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $form = $this->buildProviderSelectionForm($a_new_type);
         
         $globalProviderList = new ilLTIConsumeProviderList();
         $globalProviderList->setAvailabilityFilter(ilLTIConsumeProvider::AVAILABILITY_CREATE);
         $globalProviderList->setScopeFilter(ilLTIConsumeProviderList::SCOPE_GLOBAL);
         
         $userProviderList = new ilLTIConsumeProviderList();
         $userProviderList->setAvailabilityFilter(ilLTIConsumeProvider::AVAILABILITY_CREATE);
         $userProviderList->setScopeFilter(ilLTIConsumeProviderList::SCOPE_USER);
         $userProviderList->setCreatorFilter($DIC->user()->getId());
         
         if ($form->getFilter('title')) {
             $globalProviderList->setTitleFilter($form->getFilter('title'));
             $userProviderList->setTitleFilter($form->getFilter('title'));
         }
         
         if ($form->getFilter('category')) {
             $globalProviderList->setCategoryFilter($form->getFilter('category'));
             $userProviderList->setCategoryFilter($form->getFilter('category'));
         }
         
         if ($form->getFilter('keyword')) {
             $globalProviderList->setKeywordFilter($form->getFilter('keyword'));
             $userProviderList->setKeywordFilter($form->getFilter('keyword'));
         }
         
         if ($form->getFilter('outcome')) {
             $globalProviderList->setHasOutcomeFilter(true);
             $userProviderList->setHasOutcomeFilter(true);
         }
         
         if ($form->getFilter('internal')) {
             $globalProviderList->setIsExternalFilter(false);
             $userProviderList->setIsExternalFilter(false);
         }
         
         if ($form->getFilter('with_key')) {
             $globalProviderList->setIsProviderKeyCustomizableFilter(false);
             $userProviderList->setIsProviderKeyCustomizableFilter(false);
         }
 
         $globalProviderList->load();
         $userProviderList->load();
         
         $form->setData(array_merge(
             $globalProviderList->getTableData(),
             $userProviderList->getTableData()
         ));
         
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjLTIConsumerGUI::initCreationForms ( $a_new_type )

Definition at line 69 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilObject2GUI\fillCloneTemplate(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), initCreateForm(), and initCustomCreateForm().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $forms = array(
             self::CFORM_NEW => $this->initCreateForm($a_new_type)
         );
         
         if (ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             $forms[self::CFORM_CUSTOM_NEW] = $this->initCustomCreateForm($a_new_type);
         }
         
         //$forms[self::CFORM_IMPORT] = $this->initImportForm($a_new_type), // no import yet
         $forms[self::CFORM_CLONE] = $this->fillCloneTemplate(null, $a_new_type);
         
         return $forms;
     }

Here is the call graph for this function:

◆ initCustomCreateForm()

ilObjLTIConsumerGUI::initCustomCreateForm ( $a_new_type )

Definition at line 143 of file class.ilObjLTIConsumerGUI.php.

References $DIC.

Referenced by afterSave(), initCreationForms(), and saveCustom().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $provider = new ilLTIConsumeProvider();
         
         $form = new ilLTIConsumeProviderFormGUI($provider);
         
         $form->initForm($this->ctrl->getFormAction($this, "save"), '', '');
         
         $form->clearCommandButtons();
         $form->addCommandButton("saveCustom", $this->lng->txt($a_new_type . "_add_own_provider"));
         $form->addCommandButton("cancel", $this->lng->txt("cancel"));
         
         $form->setTitle($DIC->language()->txt($a_new_type . '_custom_new'));
         
         return $form;
     }

Here is the caller graph for this function:

◆ initHeaderAction()

ilObjLTIConsumerGUI::initHeaderAction	(	$a_sub_type = `null`,
		$a_sub_id = `null`
	)

protected

Definition at line 319 of file class.ilObjLTIConsumerGUI.php.

References $DIC, ilLTIConsumerSettingsGUI\CMD_DELIVER_CERTIFICATE, and ilUtil\getImagePath().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $return = parent::initHeaderAction($a_sub_type, $a_sub_id);
         
         if ($this->creation_mode) {
             return $return;
         }
 
         $validator = new ilCertificateDownloadValidator();
         if ($validator->isCertificateDownloadable((int) $DIC->user()->getId(), (int) $this->object->getId())) {
             $certLink = $DIC->ctrl()->getLinkTargetByClass(
                 [ilObjLTIConsumerGUI::class, ilLTIConsumerSettingsGUI::class],
                 ilLTIConsumerSettingsGUI::CMD_DELIVER_CERTIFICATE
             );
             
             $DIC->language()->loadLanguageModule('certificate');
             
             $return->addCustomCommand($certLink, 'download_certificate');
             
             $return->addHeaderIcon(
                 'cert_icon',
                 ilUtil::getImagePath('icon_cert.svg'),
                 $DIC->language()->txt('download_certificate'),
                 null,
                 null,
                 $certLink
             );
         }
         
         return $return;
     }

Here is the call graph for this function:

◆ initMetadata()

ilObjLTIConsumerGUI::initMetadata ( ilObjLTIConsumer $object )

Definition at line 297 of file class.ilObjLTIConsumerGUI.php.

References ilMD\addGeneral(), ilMD\getGeneral(), ilObject\getId(), ilObjLTIConsumer\getProvider(), ilObject2\getTitle(), ilObject2\getType(), ilMDBase\save(), and ilMDKeyword\updateKeywords().

Referenced by afterSave().

     {
         $metadata = new ilMD($object->getId(), $object->getId(), $object->getType());
         
         $generalMetadata = $metadata->getGeneral();
         
         if (!$generalMetadata) {
             $generalMetadata = $metadata->addGeneral();
         }
         
         $generalMetadata->setTitle($object->getTitle());
         $generalMetadata->save();
         
         $id = $generalMetadata->addIdentifier();
         $id->setCatalog('ILIAS');
         $id->setEntry('il__' . $object->getType() . '_' . $object->getId());
         $id->save();
         
         $keywords = $object->getProvider()->getKeywordsArray();
         ilMDKeyword::updateKeywords($generalMetadata, $keywords);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProviderFilter()

ilObjLTIConsumerGUI::resetProviderFilter ( )

protected

Definition at line 180 of file class.ilObjLTIConsumerGUI.php.

References buildProviderSelectionForm(), and ilObjectGUI\createObject().

     {
         $form = $this->buildProviderSelectionForm('');
         $form->resetFilter();
         $this->createObject();
     }

Here is the call graph for this function:

◆ saveCustom()

ilObjLTIConsumerGUI::saveCustom ( )

Definition at line 202 of file class.ilObjLTIConsumerGUI.php.

References $DIC, afterSave(), createNewObject(), ilObjectGUI\getDidacticTemplateVar(), ilObject2GUI\handleAutoRating(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), and initCustomCreateForm().

     {
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         $new_type = $_REQUEST["new_type"];
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
         
         $DIC->language()->loadLanguageModule($new_type);
         
         $form = $this->initCustomCreateForm($new_type);
         
         if ($form->checkInput()) {
             $DIC->ctrl()->setParameter($this, "new_type", "");
             
             // create object
             $newObj = $this->createNewObject(
                 $new_type,
                 $form->getInput('title'),
                 $form->getInput('desc')
             );
             
             // apply didactic template?
             $dtpl = $this->getDidacticTemplateVar("dtpl");
             if ($dtpl) {
                 $newObj->applyDidacticTemplate($dtpl);
             }
             
             // auto rating
             $this->handleAutoRating($newObj);
 
             $this->afterSave($newObj);
 
             return;
         }
         
         $form->setValuesByPost();
         
         $DIC->ui()->mainTemplate()->setContent($form->getHtml());
     }

Here is the call graph for this function:

◆ setTabs()

ilObjLTIConsumerGUI::setTabs ( )

Definition at line 526 of file class.ilObjLTIConsumerGUI.php.

References $DIC, and ilLTIConsumeProvider\AVAILABILITY_NONE.

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $DIC->language()->loadLanguageModule('lti');
 
         $DIC->help()->setScreenIdComponent("lti");
 
         if (!$this->object->getOfflineStatus() &&
             $this->object->getProvider()->getAvailability() != ilLTIConsumeProvider::AVAILABILITY_NONE
         ) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_CONTENT,
                 $DIC->language()->txt(self::TAB_ID_CONTENT),
                 $DIC->ctrl()->getLinkTargetByClass(ilLTIConsumerContentGUI::class)
             );
         }
 
         $DIC->tabs()->addTab(
             self::TAB_ID_INFO,
             $DIC->language()->txt(self::TAB_ID_INFO),
             $this->ctrl->getLinkTargetByClass(ilInfoScreenGUI::class)
         );
 
 
         if ($this->ltiAccess->hasWriteAccess()) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_SETTINGS,
                 $DIC->language()->txt(self::TAB_ID_SETTINGS),
                 $DIC->ctrl()->getLinkTargetByClass(ilLTIConsumerSettingsGUI::class)
             );
         }
         
         if ($this->ltiAccess->hasStatementsAccess()) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_STATEMENTS,
                 $DIC->language()->txt(self::TAB_ID_STATEMENTS),
                 $DIC->ctrl()->getLinkTargetByClass(ilLTIConsumerXapiStatementsGUI::class)
             );
         }
         
         if ($this->ltiAccess->hasHighscoreAccess()) {
             $DIC->language()->loadLanguageModule('lti');
             $DIC->tabs()->addTab(
                 self::TAB_ID_SCORING,
                 $DIC->language()->txt(self::TAB_ID_SCORING),
                 $DIC->ctrl()->getLinkTargetByClass(ilLTIConsumerScoringGUI::class)
             );
         }
         
         if ($this->ltiAccess->hasLearningProgressAccess() && $this->object->getProvider()->getHasOutcome()) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_LEARNING_PROGRESS,
                 $DIC->language()->txt(self::TAB_ID_LEARNING_PROGRESS),
                 $DIC->ctrl()->getLinkTargetByClass(ilLearningProgressGUI::class)
             );
         }
         
         if ($this->ltiAccess->hasWriteAccess()) {
             $gui = new ilObjectMetaDataGUI($this->object);
             $link = $gui->getTab();
             
             if (strlen($link)) {
                 $DIC->tabs()->addTab(
                     self::TAB_ID_METADATA,
                     $DIC->language()->txt('meta_data'),
                     $link
                 );
             }
         }
         
         if ($this->ltiAccess->hasEditPermissionsAccess()) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_PERMISSIONS,
                 $DIC->language()->txt(self::TAB_ID_PERMISSIONS),
                 $DIC->ctrl()->getLinkTargetByClass(ilPermissionGUI::class, 'perm')
             );
         }
         
         if (defined('DEVMODE') && DEVMODE) {
             $DIC->tabs()->addTab(
                 'debug',
                 'DEBUG',
                 $DIC->ctrl()->getLinkTarget($this, 'debug')
             );
         }
     }

◆ trackObjectReadEvent()

ilObjLTIConsumerGUI::trackObjectReadEvent ( )

protected

Definition at line 672 of file class.ilObjLTIConsumerGUI.php.

References $DIC, $object, ilChangeEvent\_recordReadEvent(), and ilLPStatusWrapper\_updateStatus().

Referenced by executeCommand().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         
         ilChangeEvent::_recordReadEvent(
             $this->object->getType(),
             $this->object->getRefId(),
             $this->object->getId(),
             $DIC->user()->getId()
         );
         
         ilLPStatusWrapper::_updateStatus($this->object->getId(), $DIC->user()->getId());
     }