GUI class for LTI provider object settings. More...

Collaboration diagram for ilLTIProviderObjectSettingGUI:

Public Member Functions
	__construct ($a_ref_id)

	hasSettingsAccess ()
	Check if user has access to lti settings. More...

	setCustomRolesForSelection ($a_roles)
	Set custom roles for mapping to LTI roles. More...

	offerLTIRolesForSelection ($a_stat)
	Offer LTI roles for mapping. More...

	executeCommand ()
	Ctrl execute command. More...

Data Fields
const	ROLE_ADMIN = 'admin'

const	ROLE_TUTOR = 'tutor'

const	ROLE_MEMBER = 'member'

Protected Member Functions
	settings (ilPropertyFormGUI $form=null)
	Show settings. More...

	initObjectSettingsForm ()
	Init object settings form. More...

	updateSettings ()
	Update settings (activate deactivate lti access) More...

	saveRoleSelection (ilPropertyFormGUI $form, $global_consumer_id)
	Save role selection for consumer. More...

	getRoleSelection ()
	Get role selection. More...

Protected Attributes
	$ctrl = null

	$logger = null

	$lng = null

	$tpl = null

	$ref_id = null

	$custom_roles = []

	$use_lti_roles = true

Detailed Description

GUI class for LTI provider object settings.

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

Definition at line 11 of file class.ilLTIProviderObjectSettingGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIProviderObjectSettingGUI::__construct ( $a_ref_id )

Parameters

int ref_id

Definition at line 57 of file class.ilLTIProviderObjectSettingGUI.php.

References $GLOBALS.

     {
         $this->ref_id = $a_ref_id;
         $this->logger = $GLOBALS['DIC']->logger()->lti();
         $this->ctrl = $GLOBALS['DIC']->ctrl();
         $this->tpl = $GLOBALS['DIC']->ui()->mainTemplate();
 
         $this->lng = $GLOBALS['DIC']->language();
         $this->lng->loadLanguageModule('lti');
     }

Member Function Documentation

◆ executeCommand()

ilLTIProviderObjectSettingGUI::executeCommand ( )

Ctrl execute command.

Definition at line 108 of file class.ilLTIProviderObjectSettingGUI.php.

     {
         $cmd = $this->ctrl->getCmd('settings');
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

◆ getRoleSelection()

ilLTIProviderObjectSettingGUI::getRoleSelection ( )

protected

Get role selection.

Returns: array

Definition at line 287 of file class.ilLTIProviderObjectSettingGUI.php.

References $options, $title, ilObjRole\_getTranslation(), and ilObject\_lookupTitle().

Referenced by initObjectSettingsForm().

     {
         $options = [];
         $options[0] = $this->lng->txt('select_one');
         foreach ($this->custom_roles as $role_id) {
             $title = ilObjRole::_getTranslation(ilObjRole::_lookupTitle($role_id));
             $options[$role_id] = $title;
         }
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSettingsAccess()

ilLTIProviderObjectSettingGUI::hasSettingsAccess ( )

Check if user has access to lti settings.

Parameters

int	ref_id
int	user_id

Definition at line 73 of file class.ilLTIProviderObjectSettingGUI.php.

References $GLOBALS, ilObject\_lookupType(), and ilObjLTIAdministration\lookupLTISettingsRefId().

     {
         if (!ilObjLTIAdministration::isEnabledForType(ilObject::_lookupType($this->ref_id, true))) {
             $this->logger->debug('No LTI consumers activated for object type: ' . ilObject::_lookupType($this->ref_id, true));
             return false;
         }
         $access = $GLOBALS['DIC']->rbac()->system();
         return $access->checkAccess(
             'release_objects',
             ilObjLTIAdministration::lookupLTISettingsRefId()
         );
     }

Here is the call graph for this function:

◆ initObjectSettingsForm()

ilLTIProviderObjectSettingGUI::initObjectSettingsForm ( )

protected

Init object settings form.

Definition at line 136 of file class.ilLTIProviderObjectSettingGUI.php.

References $form, $GLOBALS, $key, $ref_id, $secret, $section, $url, ilObject\_lookupType(), ilLTIToolConsumer\fromGlobalSettingsAndRefId(), getRoleSelection(), ilFormPropertyGUI\setInfo(), and ilSelectInputGUI\setOptions().

Referenced by settings(), and updateSettings().

     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
         $form->setTitle($this->lng->txt('lti_object_release_settings_form'));
         
         foreach (ilObjLTIAdministration::getEnabledConsumersForType(ilObject::_lookupType($this->ref_id, true)) as $global_consumer) {
             $object_info = new ilLTIProviderObjectSetting($this->ref_id, $global_consumer->getExtConsumerId());
             
             $this->logger->debug($object_info->getAdminRole());
             
             
             // meta data for external consumers
             $section = new ilFormSectionHeaderGUI();
             $section->setTitle($global_consumer->getTitle());
             $section->setInfo($global_consumer->getDescription());
             $form->addItem($section);
 
             $connector = new ilLTIDataConnector();
             
             $active_consumer = ilLTIToolConsumer::fromGlobalSettingsAndRefId(
                 $global_consumer->getExtConsumerId(),
                 $this->ref_id,
                 $connector
             );
             
             $active = new ilCheckboxInputGUI($GLOBALS['lng']->txt('lti_obj_active'), 'lti_active_' . $global_consumer->getExtConsumerId());
             $active->setInfo($GLOBALS['lng']->txt('lti_obj_active_info'));
             $active->setValue(1);
             $form->addItem($active);
 
             if ($active_consumer->getEnabled()) { // and enabled
                 $active->setChecked(true);
                 
                 $url = new ilNonEditableValueGUI($this->lng->txt('lti_launch_url'), 'url');
                 $url->setValue(ILIAS_HTTP_PATH . '/lti.php?client_id=' . CLIENT_ID);
                 $active->addSubItem($url);
                 
                 $key = new ilNonEditableValueGUI($this->lng->txt('lti_consumer_key'), 'key');
                 $key->setValue($active_consumer->getKey());
                 $active->addSubItem($key);
                 
                 $secret = new ilNonEditableValueGUI($this->lng->txt('lti_consumer_secret'), 'secret');
                 $secret->setValue($active_consumer->getSecret());
                 $active->addSubItem($secret);
             }
             
             if ($this->custom_roles) {
                 $admin = new ilSelectInputGUI(
                     $this->lng->txt('lti_admin'),
                     'lti_admin_' . $global_consumer->getExtConsumerId()
                 );
                 $admin->setOptions($this->getRoleSelection());
                 $admin->setValue($object_info->getAdminRole() ? $object_info->getAdminRole() : 0);
                 $active->addSubItem($admin);
 
                 $tutor = new ilSelectInputGUI(
                     $this->lng->txt('lti_tutor'),
                     'lti_tutor_' . $global_consumer->getExtConsumerId()
                 );
                 $tutor->setOptions($this->getRoleSelection());
                 $tutor->setValue($object_info->getTutorRole() ? $object_info->getTutorRole() : 0);
                 $active->addSubItem($tutor);
 
                 $member = new ilSelectInputGUI(
                     $this->lng->txt('lti_member'),
                     'lti_member_' . $global_consumer->getExtConsumerId()
                 );
                 $member->setOptions($this->getRoleSelection());
                 $member->setValue($object_info->getMemberRole() ? $object_info->getMemberRole() : 0);
                 $active->addSubItem($member);
             }
         }
         
         $form->addCommandButton('updateSettings', $this->lng->txt('save'));
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ offerLTIRolesForSelection()

ilLTIProviderObjectSettingGUI::offerLTIRolesForSelection ( $a_stat )

Offer LTI roles for mapping.

Parameters

bool $a_stat

Definition at line 99 of file class.ilLTIProviderObjectSettingGUI.php.

     {
         $this->use_lti_roles = $a_stat;
     }

◆ saveRoleSelection()

ilLTIProviderObjectSettingGUI::saveRoleSelection	(	ilPropertyFormGUI	$form,
			$global_consumer_id
	)

protected

Save role selection for consumer.

Parameters

ilPropertyFormGUI	$form
type	$global_consumer_id

Definition at line 263 of file class.ilLTIProviderObjectSettingGUI.php.

References ilPropertyFormGUI\getInput().

Referenced by updateSettings().

     {
         $object_info = new ilLTIProviderObjectSetting($this->ref_id, $global_consumer_id);
         
         $admin_role = $form->getInput('lti_admin_' . $global_consumer_id);
         if ($admin_role > 0) {
             $object_info->setAdminRole($admin_role);
         }
         $tutor_role = $form->getInput('lti_tutor_' . $global_consumer_id);
         if ($tutor_role > 0) {
             $object_info->setTutorRole($tutor_role);
         }
         $member_role = $form->getInput('lti_member_' . $global_consumer_id);
         if ($member_role > 0) {
             $object_info->setMemberRole($member_role);
         }
         $object_info->save();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCustomRolesForSelection()

ilLTIProviderObjectSettingGUI::setCustomRolesForSelection ( $a_roles )

Set custom roles for mapping to LTI roles.

Parameters

type $a_roles

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

Referenced by ilObjSAHSLearningModuleGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilObjSurveyGUI\executeCommand(), ilObjContentObjectGUI\executeCommand(), ilObjTestGUI\executeCommand(), and ilObjCourseGUI\executeCommand().

     {
         $this->custom_roles = $a_roles;
     }

Here is the caller graph for this function:

◆ settings()

ilLTIProviderObjectSettingGUI::settings ( ilPropertyFormGUI $form = null )

protected

Show settings.

Parameters

ilPropertyFormGUI $form

Definition at line 124 of file class.ilLTIProviderObjectSettingGUI.php.

References $form, and initObjectSettingsForm().

Referenced by updateSettings().

     {
         if (!$form instanceof ilPropertyFormGUI) {
             $form = $this->initObjectSettingsForm();
         }
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSettings()

ilLTIProviderObjectSettingGUI::updateSettings ( )

protected

Update settings (activate deactivate lti access)

Definition at line 217 of file class.ilLTIProviderObjectSettingGUI.php.

References $consumer, $form, $ref_id, ilObject\_lookupType(), ilLTIToolConsumer\fromGlobalSettingsAndRefId(), initObjectSettingsForm(), saveRoleSelection(), ilUtil\sendSuccess(), and settings().

     {
         $form = $this->initObjectSettingsForm();
         if (!$form->checkInput()) {
             $form->setValuesByPost();
             $this->settings($form);
             return;
         }
         
         $connector = new ilLTIDataConnector();
         foreach (ilObjLTIAdministration::getEnabledConsumersForType(ilObject::_lookupType($this->ref_id, true)) as $global_consumer) {
             $this->saveRoleSelection($form, $global_consumer->getExtConsumerId());
             
             $consumer = ilLTIToolConsumer::fromGlobalSettingsAndRefId(
                 $global_consumer->getExtConsumerId(),
                 $this->ref_id,
                 $connector
             );
             if (!$form->getInput('lti_active_' . $global_consumer->getExtConsumerId())) {
                 // not active anymore => delete consumer
                 if ($consumer->getEnabled()) {
                     $this->logger->info('Deleting lti consumer for object reference: ' . $this->ref_id);
                     $consumer->delete();
                 }
             } else {
                 // new activation
                 if (!$consumer->getEnabled()) {
                     $this->logger->info('Created new lti release for: ' . $this->ref_id);
                     $consumer->setExtConsumerId($global_consumer->getExtConsumerId());
                     $consumer->createSecret();
                     $consumer->setRefId($this->ref_id);
                     $consumer->setEnabled(true);
                     $consumer->saveLTI($connector);
                 }
             }
         }
         
         ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
         $this->ctrl->redirect($this, 'settings');
     }