Inheritance diagram for ilObjLTIConsumerGUI:

Collaboration diagram for ilObjLTIConsumerGUI:

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

	getType ()

	initDynRegForm (string $a_new_type)

	initShowToolConfig (string $a_new_type, int $a_provider_id)

	initCustomCreateForm (string $a_new_type)

	saveCustom ()

	addDynReg ()

	cancelDynReg ()

	showToolConfig ()

	saveDynReg ()

	contentSelection (string $providerId, string $newType, string $refId, ilLTIConsumeProvider $provider)

	contentSelectionRequest ()

	contentSelectionResponse ()

	cancelContentSelection ()

	saveContentSelection (ilLTIConsumeProvider $provider, string $token)

	initMetadata (\ilObject $object)

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	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 (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

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

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

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

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

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	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...

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

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

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

	saveObject ()

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

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

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

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

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

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

	setColumnSettings (ilColumnGUI $column_gui)

	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 (string $a_target)

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

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

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
const	CFORM_CUSTOM_NEW = 99

const	CFORM_DYNAMIC_REGISTRATION = 98

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_GRADE_SYNCHRONIZATION = 'tab_grade_synchronization'

const	TAB_ID_METADATA = 'tab_metadata'

const	TAB_ID_LEARNING_PROGRESS = 'learning_progress'

const	TAB_ID_PERMISSIONS = 'perm_settings'

const	DEFAULT_CMD = 'launch'

ilObject	$object = null

int	$parent_node_id = 0

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	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Member Functions
	initCreateForm (string $a_new_type)

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $forms)

	initNewForm (string $a_new_type)

	buildProviderSelectionForm (string $a_new_type)

	applyProviderFilter ()

	resetProviderFilter ()

	createNewObject (string $newType, string $title, string $description)

	afterSave (\ilObject $newObject)

	initHeaderAction (?string $a_sub_type=null, ?int $a_sub_id=null)

	checkContentSelection ()

	setTabs ()

	addLocatorItems ()

	trackObjectReadEvent ()

	infoScreen ()

	infoScreenForward ()

	handleAvailablityMessage ()

	getRequestValue (string $key)

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 ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	addAdminLocatorItems (bool $do_not_add_object=false)

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

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

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

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

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

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	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 More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

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

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

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

	initEditForm ()

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

	getEditFormValues ()

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

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

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

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

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

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

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

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

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

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

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ilLTIConsumerAccess	$ltiAccess

LOMServices	$lom_services

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 64 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);
         $this->parent_node_id = $a_parent_node_id;
         if ($this->object instanceof ilObjLTIConsumer) {
             $this->ltiAccess = new ilLTIConsumerAccess($this->object);
         }
         $this->lom_services = $DIC->learningObjectMetadata();
 
         $DIC->language()->loadLanguageModule("lti");
         $DIC->language()->loadLanguageModule("rep");
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjLTIConsumerGUI::_goto ( string $a_target )

static

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

References ilObject2GUI\$access, ilObject2GUI\$ctrl, $DIC, ilObjectGUI\$id, ilObject2GUI\$lng, $object, ilObjectGUI\$request, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObjectGUI\addHeaderAction(), ilRBACAccessHandler\checkAccess(), checkContentSelection(), ilObject2GUI\executeCommand(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getType(), infoScreen(), ILIAS\Repository\int(), ilLTIConsumerContentGUI\isEmbeddedLaunchRequest(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), ilCtrl\setTargetScript(), trackObjectReadEvent(), and ilLanguage\txt().

                                                   : void
     {
         global $DIC;
         $main_tpl = $DIC->ui()->mainTemplate();
         /* @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->setParameterByClass(ilObjLTIConsumerGUI::class, 'ref_id', $id);
             $ctrl->redirectByClass([ilRepositoryGUI::class, ilObjLTIConsumerGUI::class]);
         } elseif ($access->checkAccess('visible', '', $id)) {
             ilObjectGUI::_gotoRepositoryNode($id, 'infoScreen');
         } elseif ($access->checkAccess('read', '', ROOT_FOLDER_ID)) {
             $main_tpl->setOnScreenMessage(
                 'info',
                 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:

◆ addDynReg()

ilObjLTIConsumerGUI::addDynReg ( )

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

References $DIC, ilObject2GUI\$error, getRequestValue(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), initDynRegForm(), and null.

                                : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
 
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
 
         $DIC->language()->loadLanguageModule($new_type);
         $form = $this->initDynRegForm($new_type);
         $error = ($this->getRequestValue('error') != null) ? $this->getRequestValue('error') : "";
         $form->setValuesByPost();
         if (!empty($error)) {
             $DIC->ctrl()->setParameter($this, "new_type", "");
             $DIC->ui()->mainTemplate()->setOnScreenMessage('failure', base64_decode($error));
             $DIC->ui()->mainTemplate()->setContent($form->getDynRegError());
             return;
         }
         if ($form->checkInput()) {
             $DIC->ctrl()->setParameter($this, "new_type", "");
             $DIC->ui()->mainTemplate()->setContent($form->getDynRegRequest());
             return;
         }
         $DIC->ui()->mainTemplate()->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ addLocatorItems()

ilObjLTIConsumerGUI::addLocatorItems ( )

protected

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

References $DIC, ilObject2GUI\$locator, ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                         : void
     {
         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),
             "",
             $this->object->getRefId()
         );
     }

Here is the call graph for this function:

◆ afterSave()

ilObjLTIConsumerGUI::afterSave ( \ilObject $newObject )

protected

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

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

Referenced by saveCustom().

                                                       : void
     {
         global $DIC; //check
 
         if ($DIC->http()->wrapper()->query()->has('provider_id')) {
             $newObject->setProviderId((int) $DIC->http()->wrapper()->query()->retrieve('provider_id', $DIC->refinery()->kindlyTo()->int()));
             $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 239 of file class.ilObjLTIConsumerGUI.php.

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

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

Here is the call graph for this function:

◆ buildProviderSelectionForm()

ilObjLTIConsumerGUI::buildProviderSelectionForm ( string $a_new_type )

protected

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

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

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

Here is the caller graph for this function:

◆ cancelContentSelection()

ilObjLTIConsumerGUI::cancelContentSelection ( )

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

References $DIC, getRequestValue(), and ilLTIConsumerAccess\hasCustomProviderCreationAccess().

                                             : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         $DIC->ctrl()->setParameterByClass(ilRepositoryGUI::class, 'new_type', $new_type);
         $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class, 'create');
     }

Here is the call graph for this function:

◆ cancelDynReg()

ilObjLTIConsumerGUI::cancelDynReg ( )

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

References $DIC, Vendor\Package\$e, $provider, $providerId, ilSession\get(), ilLTIConsumeProvider\getProviderIdFromClientId(), getRequestValue(), ilSession\has(), and ilLTIConsumerAccess\hasCustomProviderCreationAccess().

                                   : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         //$provider_id = $this->getRequestValue("provider_id");
         if (ilSession::has('lti_dynamic_registration_client_id')) {
             $providerId = ilLTIConsumeProvider::getProviderIdFromClientId(ilSession::get('lti_dynamic_registration_client_id'));
             if ($providerId > 0) {
                 try {
                     $provider = new ilLTIConsumeProvider($providerId);
                     //ToDo: check if provider is in use? should never happen...
                     $provider->delete();
                 } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                     //ToDo: error handling
                 }
             }
         }
         $DIC->ctrl()->setParameterByClass(ilRepositoryGUI::class, 'new_type', $new_type);
         $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class, 'create');
     }

Here is the call graph for this function:

◆ checkContentSelection()

ilObjLTIConsumerGUI::checkContentSelection ( )

protected

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

References $DIC, $provider, $providerId, $refId, contentSelection(), getRequestValue(), null, and ilObject2GUI\save().

Referenced by _goto().

                                               : void
     {
         global $DIC;
         $providerId = $this->getRequestValue('provider_id');
         $newType = $this->getRequestValue('new_type');
         $refId = $this->getRequestValue('ref_id');
         if ($providerId !== null && $newType == 'lti' && $refId != null) {
             $provider = new ilLTIConsumeProvider((int) $providerId);
             // check if post variables from contentSelectionResponse
             if ($DIC->http()->wrapper()->post()->has('JWT')) {
                 // ToDo:
             } else {
                 if ($provider->isContentItem() && !empty($provider->getContentItemUrl())) {
                     $this->contentSelection($providerId, $newType, $refId, $provider);
                 } else {
                     $this->save();
                 }
             }
         } else {
             $this->save();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contentSelection()

ilObjLTIConsumerGUI::contentSelection	(	string	$providerId,
		string	$newType,
		string	$refId,
		ilLTIConsumeProvider	$provider
	)

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

References $DIC, ILIAS\Repository\ctrl(), and ilLTIConsumerAccess\hasCustomProviderCreationAccess().

Referenced by checkContentSelection().

                                                                                                                         : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $DIC->ctrl()->setParameter($this, "new_type", $newType);
         $DIC->ctrl()->setParameter($this, "provider_id", $providerId);
         $DIC->ctrl()->setParameter($this, "ref_id", $refId);
 
         $form = new ilLTIConsumeProviderFormGUI($provider);
         $formaction = $this->ctrl->getFormAction($this, "cancelContentSelection");
         $DIC->ui()->mainTemplate()->setContent($form->getContentSelectionFrame($formaction));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contentSelectionRequest()

ilObjLTIConsumerGUI::contentSelectionRequest ( )

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

References ilObjectGUI\$data, $DIC, $ltiMessageHint, $provider, ilObjectGUI\$ref_id, ilObjLTIConsumer\buildContentSelectionParameters(), ilSession\clear(), CLIENT_ID, exit, ilSession\get(), ilCmiXapiUser\getIdentAsId(), ilObjLTIConsumer\getIliasHttpPath(), getRequestValue(), ilSession\has(), and ilLTIConsumerAccess\hasCustomProviderCreationAccess().

                                              : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
         $provider_id = $this->getRequestValue("provider_id");
         $DIC->ctrl()->setParameter($this, "provider_id", $provider_id);
         $ref_id = $this->getRequestValue("ref_id");
         $DIC->ctrl()->setParameter($this, "ref_id", $ref_id);
         $DIC->language()->loadLanguageModule($new_type);
         $provider = new ilLTIConsumeProvider((int) $provider_id);
         $redirectUrl = $DIC->ctrl()->getLinkTarget($this, 'contentSelectionRequest');
 
         if (!ilSession::has('lti13_login_data')) {
             $userIdLTI = ilCmiXapiUser::getIdentAsId($provider->getPrivacyIdent(), $DIC->user());
             //$emailPrimary = ilCmiXapiUser::getIdent($provider->getPrivacyIdent(), $DIC->user());
             $ltiMessageHint = (string) $ref_id . ":" . CLIENT_ID . ":" . base64_encode($redirectUrl);
             $tplLogin = new ilTemplate("tpl.lti_initial_login.html", true, true, "components/ILIAS/LTIConsumer");
             $tplLogin->setVariable("LTI_INITIAL_LOGIN_ACTION", $provider->getInitiateLogin());
             $tplLogin->setVariable("ISS", ilObjLTIConsumer::getIliasHttpPath());
             $tplLogin->setVariable("TARGET_LINK_URL", $provider->getProviderUrl());
             $tplLogin->setVariable("LOGIN_HINT", $userIdLTI);
             $tplLogin->setVariable("LTI_MESSAGE_HINT", $ltiMessageHint);
             $tplLogin->setVariable("CLIENT_ID", $provider->getClientId());
             $tplLogin->setVariable("LTI_DEPLOYMENT_ID", (string) $provider->getId());
             echo $tplLogin->get();
             exit; //TODO: no exit
         } else {
             $loginData = ilSession::get('lti13_login_data');
             // ToDo: correct Link!! replace ILIAS_HTTP_PATH
             $data = ilObjLTIConsumer::buildContentSelectionParameters($provider, (int) $ref_id, ilObjLTIConsumer::getIliasHttpPath() . "/" . $DIC->ctrl()->getLinkTarget($this, 'contentSelectionResponse'), $loginData['nonce']);
             $tplContentSelection = new ilTemplate("tpl.lti_jwt_autosubmit.html", true, true, "components/ILIAS/LTIConsumer");
             $tplContentSelection->setVariable("LTI_JWT_FORM_ACTION", $provider->getContentItemUrl());
             $tplContentSelection->setVariable("LTI_JWT_ID_TOKEN", $data['id_token']);
             $tplContentSelection->setVariable("LTI_JWT_STATE", $loginData['state']);
             ilSession::clear('lti13_login_data');
             echo $tplContentSelection->get();
             exit; //TODO: no exit
         }
     }

Here is the call graph for this function:

◆ contentSelectionResponse()

ilObjLTIConsumerGUI::contentSelectionResponse ( )

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

References $DIC, $provider, ilObjectGUI\$ref_id, $token, exit, getRequestValue(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), and saveContentSelection().

                                               : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
         $provider_id = $this->getRequestValue("provider_id");
         $DIC->ctrl()->setParameter($this, "provider_id", $provider_id);
         $ref_id = $this->getRequestValue("ref_id");
         $DIC->ctrl()->setParameter($this, "ref_id", $ref_id);
         $DIC->language()->loadLanguageModule($new_type);
         $token = '';
         if ($DIC->http()->wrapper()->post()->has('JWT')) {
             $token = $DIC->http()->wrapper()->post()->retrieve('JWT', $DIC->refinery()->kindlyTo()->string());
         }
         if ($DIC->http()->wrapper()->post()->has('jwt')) {
             $token = $DIC->http()->wrapper()->post()->retrieve('jwt', $DIC->refinery()->kindlyTo()->string());
         }
         if (!empty($token)) {
             $provider = new ilLTIConsumeProvider((int) $provider_id);
             $this->saveContentSelection($provider, $token);
         } else {
             echo "no token";
             exit;
             //ToDo:
         }
     }

Here is the call graph for this function:

◆ createNewObject()

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

protected

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

References ilObject2GUI\putObjectInTree().

Referenced by saveCustom().

                                                                                            : ilObject
     {
         $classname = "ilObj" . $this->obj_definition->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:

◆ getCreationFormsHTML()

ilObjLTIConsumerGUI::getCreationFormsHTML ( StandardForm|ilPropertyFormGUI|array $forms )

protected

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

References ilAccordionGUI\FIRST_OPEN, ilPropertyFormGUI\getHTML(), and ilPropertyFormGUI\getTitle().

                                                                                         : string
     {
         if (!is_array($forms)) {
             throw new Exception('We only deal with arrays here.');
         }
 
         $acc = new ilAccordionGUI();
         $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
         array_walk(
             $forms,
             function (ilPropertyFormGUI $v, string $k) use ($acc): void {
                 $acc->addItem(
                     $v->getTitle(),
                     $v->getHTML()
                 );
             }
         );
 
         return $acc->getHTML();
     }

Here is the call graph for this function:

◆ getRequestValue()

ilObjLTIConsumerGUI::getRequestValue ( string $key )

protected

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

References null, and ILIAS\Repository\refinery().

Referenced by addDynReg(), cancelContentSelection(), cancelDynReg(), checkContentSelection(), contentSelectionRequest(), contentSelectionResponse(), saveContentSelection(), saveCustom(), saveDynReg(), and showToolConfig().

                                                    : ?string
     {
         if ($this->request_wrapper->has($key)) {
             return $this->request_wrapper->retrieve($key, $this->refinery->kindlyTo()->string());
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilObjLTIConsumerGUI::getType ( )

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

Referenced by _goto().

                              : string
     {
         return 'lti';
     }

Here is the caller graph for this function:

◆ handleAvailablityMessage()

ilObjLTIConsumerGUI::handleAvailablityMessage ( )

protected

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

References $DIC, ilLTIConsumeProvider\AVAILABILITY_NONE, and ILIAS\Repository\object().

Referenced by infoScreenForward().

                                                  : void
     {
         global $DIC;
         /* @var \ILIAS\DI\Container $DIC */
         if ($this->object->getProvider()->getProviderUrl() == '') {
             $this->tpl->setOnScreenMessage('failure', $DIC->language()->txt('lti_provider_not_set_msg'));
         } elseif ($this->object->getProvider()->getAvailability() == ilLTIConsumeProvider::AVAILABILITY_NONE) {
             $this->tpl->setOnScreenMessage('failure', $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 1044 of file class.ilObjLTIConsumerGUI.php.

References $DIC, and infoScreenForward().

Referenced by _goto().

                                    : void
     {
         global $DIC;
         /* @var \ILIAS\DI\Container $DIC */
 
         $DIC->tabs()->activateTab(self::TAB_ID_INFO);
 
         // @todo: removed deprecated ilCtrl methods, this needs inspection by a maintainer.
         // $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 1057 of file class.ilObjLTIConsumerGUI.php.

References $DIC, $ilErr, ilLPObjSettings\_lookupDBMode(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilObjCmiXapiGUI\getPrivacyIdentString(), ilObjCmiXapiGUI\getPrivacyNameString(), handleAvailablityMessage(), and ILIAS\Repository\object().

Referenced by infoScreen().

                                           : void
     {
         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"), $ilErr->MESSAGE);
         }
 
         $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) {
                 //todo check
                 $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', (string) $this->object->getId());
             $info->addProperty('Current User ID', (string) $DIC->user()->getId());
         }
         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 ( string $a_new_type )

protected

Returns: array<ilPropertyFormGUI>

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

References ilLTIConsumerAccess\hasCustomProviderCreationAccess(), initCustomCreateForm(), initDynRegForm(), and initNewForm().

                                                          : array
     {
         $forms = array(
             self::CFORM_NEW => $this->initNewForm($a_new_type)
         );
 
         if (ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             $forms[self::CFORM_DYNAMIC_REGISTRATION] = $this->initDynRegForm($a_new_type);
             $forms[self::CFORM_CUSTOM_NEW] = $this->initCustomCreateForm($a_new_type);
         }
 
         return $forms;
     }

Here is the call graph for this function:

◆ initCustomCreateForm()

ilObjLTIConsumerGUI::initCustomCreateForm ( string $a_new_type )

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

References $DIC, $provider, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

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

                                                             : \ilLTIConsumeProviderFormGUI
     {
         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 call graph for this function:

Here is the caller graph for this function:

◆ initDynRegForm()

ilObjLTIConsumerGUI::initDynRegForm ( string $a_new_type )

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

References $DIC, $provider, and ILIAS\Repository\ctrl().

Referenced by addDynReg(), and initCreateForm().

                                                       : \ilLTIConsumeProviderFormGUI
     {
         global $DIC;
         /* @var \ILIAS\DI\Container $DIC */
         $provider = new ilLTIConsumeProvider();
         $form = new ilLTIConsumeProviderFormGUI($provider);
         $form->initDynRegForm($this->ctrl->getFormAction($this, "cancelDynReg"));
         $form->setTitle($DIC->language()->txt($a_new_type . '_dynamic_registration'));
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHeaderAction()

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

protected

Returns: ilObjectListGUI

Exceptions

ilCtrlException

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

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

                                                                                           : ?\ilObjectListGUI
     {
         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($DIC->user()->getId(), $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('standard/icon_cert.svg'),
                 $DIC->language()->txt('download_certificate'),
                 null,
                 null,
                 $certLink
             );
         }
 
         return $return;
     }

Here is the call graph for this function:

◆ initMetadata()

ilObjLTIConsumerGUI::initMetadata ( \ilObject $object )

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

References ilObject\getId(), ilObject\getTitle(), and ilObject\getType().

Referenced by afterSave(), and saveContentSelection().

                                                    : void
     {
         // create LOM set from scratch
         $this->lom_services->derive()
                            ->fromBasicProperties($object->getTitle())
                            ->forObject($object->getId(), $object->getId(), $object->getType());
 
         // in a second step, set the keywords
         $keywords = [];
         foreach ($object->getProvider()->getKeywordsArray() as $keyword) {
             if ($keyword !== '') {
                 $keywords[] = $keyword;
             }
         }
         $this->lom_services->manipulate($object->getId(), $object->getId(), $object->getType())
                            ->prepareCreateOrUpdate(
                                $this->lom_services->paths()->keywords(),
                                ...$keywords
                            )->execute();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initNewForm()

ilObjLTIConsumerGUI::initNewForm ( string $a_new_type )

protected

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

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

Referenced by initCreateForm().

                                                       : \ilLTIConsumerProviderSelectionFormTableGUI
     {
         global $DIC;
         /* @var \ILIAS\DI\Container $DIC */
 
         $form = $this->buildProviderSelectionForm($a_new_type);
 
         $globalProviderList = new ilLTIConsumeProviderList();
         $globalProviderList->setAvailabilityFilter((string) ilLTIConsumeProvider::AVAILABILITY_CREATE);
         $globalProviderList->setScopeFilter(ilLTIConsumeProviderList::SCOPE_GLOBAL);
 
         $userProviderList = new ilLTIConsumeProviderList();
         $userProviderList->setAvailabilityFilter((string) 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([...$globalProviderList->getTableData(), ...$userProviderList->getTableData()]);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initShowToolConfig()

ilObjLTIConsumerGUI::initShowToolConfig	(	string	$a_new_type,
		int	$a_provider_id
	)

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

References $DIC, $provider, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by saveDynReg(), and showToolConfig().

                                                                               : \ilLTIConsumeProviderFormGUI
     {
         global $DIC;
 
         //ToDo: Error Handling
         $provider = new ilLTIConsumeProvider($a_provider_id);
 
         $form = new ilLTIConsumeProviderFormGUI($provider);
 
         $form->initToolConfigForm($this->ctrl->getFormAction($this, "cancelDynReg"), '', '');
 
         $form->clearCommandButtons();
         $form->addCommandButton("saveDynReg", $this->lng->txt('save'));
         $form->addCommandButton("cancelDynReg", $this->lng->txt("cancel"));
 
         $form->setTitle($DIC->language()->txt($a_new_type . '_custom_new'));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProviderFilter()

ilObjLTIConsumerGUI::resetProviderFilter ( )

protected

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

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

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

Here is the call graph for this function:

◆ saveContentSelection()

ilObjLTIConsumerGUI::saveContentSelection	(	ilLTIConsumeProvider	$provider,
		string	$token
	)

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

References ilObjectGUI\$data, $provider, $refId, ilObject2GUI\$type, exit, ilObjLTIConsumer\getIliasHttpPath(), ilLTIConsumeProvider\getKeyType(), ilLTIConsumeProvider\getPublicKey(), ilLTIConsumeProvider\getPublicKeyset(), getRequestValue(), ilObjectFactory\getTypeByRefId(), and initMetadata().

Referenced by contentSelectionResponse().

                                                                                        : void
     {
         if ($provider->getKeyType() == 'RSA_KEY') {
             $key = $provider->getPublicKey();
             $keys = new Firebase\JWT\Key($key, "RS256");
         } else {
             $jwks = file_get_contents($provider->getPublicKeyset());
             //ToDo: Errorhandling
             $keyset = json_decode($jwks, true);
             $keys = Firebase\JWT\JWK::parseKeySet($keyset);
         }
         $data = Firebase\JWT\JWT::decode($token, $keys);
         //ilObjLTIConsumer::getLogger()->debug(var_export($data,TRUE));
         $refId = $this->getRequestValue('ref_id');
 
         foreach ($data->{'https://purl.imsglobal.org/spec/lti-dl/claim/content_items'} as $item) {
             $gui = new ilObjLTIConsumerGUI(0, self::REPOSITORY_NODE_ID, (int) $refId);
             $description = "";
             if (isset($item->description)) {
                 $description = $item->description;
             }
             $newObj = $gui->createNewObject('lti', $item->title, $description);
             $dtpl = $gui->getDidacticTemplateVar("dtpl");
             if ($dtpl) {
                 $newObj->applyDidacticTemplate($dtpl);
             }
 
             $newObj->setProviderId($provider->getId());
             $newObj->setProvider($provider);
             // custom params
             $customParams = [];
             foreach ($item->{'custom'} as $key => $value) {
                 $customParams[] = $key . "=" . $value;
             }
             if (count($customParams) > 0) {
                 $newObj->setCustomParams(implode(";", $customParams));
             }
             $newObj->save();
             $this->initMetadata($newObj);
         }
         $type = ilObjectFactory::getTypeByRefId((int) $refId);
         $template = new ilTemplate('tpl.lti_content_selection_finished.html', true, true, 'components/ILIAS/LTIConsumer');
         $redirect = ilObjLTIConsumer::getIliasHttpPath() . "/" . "goto.php?target=" . $type . "_" . $refId;
         $template->setVariable("CONTENT_SELECTION_REDIRECT", $redirect);
         echo $template->get();
         exit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCustom()

ilObjLTIConsumerGUI::saveCustom ( )

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

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

                                 : void
     {
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
 
         global $DIC;
         /* @var \ILIAS\DI\Container $DIC */
 
         $new_type = $this->getRequestValue("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);
             }
 
             $this->afterSave($newObj);
 
             return;
         }
 
         $form->setValuesByPost();
 
         $DIC->ui()->mainTemplate()->setContent($form->getHtml());
     }

Here is the call graph for this function:

◆ saveDynReg()

ilObjLTIConsumerGUI::saveDynReg ( )

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

References $DIC, $provider, ilSession\clear(), getRequestValue(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), and initShowToolConfig().

                                 : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
         $provider_id = $this->getRequestValue("provider_id");
         $DIC->ctrl()->setParameter($this, "provider_id", $provider_id);
         $DIC->language()->loadLanguageModule($new_type);
         ilSession::clear('lti_dynamic_registration_client_id');
         ilSession::clear('lti_dynamic_registration_custom_params');
         $form = $this->initShowToolConfig($new_type, (int) $provider_id);
         $form->setValuesByPost();
         if ($form->checkInput()) { // update only overridable fields
             $provider = $form->getProvider();
             $form->initProvider($provider);
             $provider->update();
             // jump to provider selection is one option:
             // $DIC->ctrl()->redirectByClass([ilRepositoryGUI::class, ilObjLTIConsumerGUI::class],"create");
             // direct redirection to save is onle less click (there is a switch for save | contentSelection in GUI class):
             $DIC->ctrl()->redirectByClass([ilRepositoryGUI::class, ilObjLTIConsumerGUI::class], "save");
             return;
         }
         $DIC->ui()->mainTemplate()->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ setTabs()

ilObjLTIConsumerGUI::setTabs ( )

protected

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

References $DIC, ilLTIConsumeProvider\AVAILABILITY_NONE, ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                 : void
     {
         global $DIC;
 
         /* @var \ILIAS\DI\Container $DIC */
         $DIC->language()->loadLanguageModule('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->object->getProvider()->isGradeSynchronization()) {
             $DIC->tabs()->addTab(
                 self::TAB_ID_GRADE_SYNCHRONIZATION,
                 $DIC->language()->txt(self::TAB_ID_GRADE_SYNCHRONIZATION),
                 $DIC->ctrl()->getLinkTargetByClass(ilLTIConsumerGradeSynchronizationGUI::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')
         //            );
         //        }
     }

Here is the call graph for this function:

◆ showToolConfig()

ilObjLTIConsumerGUI::showToolConfig ( )

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

References $DIC, getRequestValue(), ilLTIConsumerAccess\hasCustomProviderCreationAccess(), and initShowToolConfig().

                                     : void
     {
         global $DIC;
         if (!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) {
             throw new ilLtiConsumerException('permission denied!');
         }
         $new_type = $this->getRequestValue("new_type");
         $DIC->ctrl()->setParameter($this, "new_type", $new_type);
         $provider_id = $this->getRequestValue("provider_id");
         $DIC->ctrl()->setParameter($this, "provider_id", $provider_id);
         $DIC->language()->loadLanguageModule($new_type);
         $form = $this->initShowToolConfig($new_type, (int) $provider_id);
         $DIC->ui()->mainTemplate()->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ trackObjectReadEvent()

ilObjLTIConsumerGUI::trackObjectReadEvent ( )

protected

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

References $DIC, $object, ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Launch\launch(), and ILIAS\Repository\object().

Referenced by _goto().

                                              : void
     {
         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());
     }