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

	checkLocalRole ()
	check for local roles for lti objects which are not grp or crs 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.

    {
        $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');
    }

References $GLOBALS.

Member Function Documentation

◆ checkLocalRole()

ilLTIProviderObjectSettingGUI::checkLocalRole ( )

protected

check for local roles for lti objects which are not grp or crs

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

    {
        global $DIC;
        $a_global_role = ilObject::_getIdsForTitle("il_lti_global_role", "role", false);
        if (is_array($a_global_role) && !empty($a_global_role)) {
            $rbacreview = $DIC['rbacreview'];
            if (count($rbacreview->getRolesOfObject($this->ref_id, false)) == 0) {
                $rbacadmin = $DIC['rbacadmin'];
                $type = ilObject::_lookupType($this->ref_id, true);
                $role = new ilObjRole();
                $role->setTitle("il_lti_learner");
                $role->setDescription("LTI Learner of " . $type . " obj_no." . ilObject::_lookupObjectId($this->ref_id));
                $role->create();
                $rbacadmin->assignRoleToFolder($role->getId(), $this->ref_id, 'y');
                $rbacadmin->grantPermission($role->getId(), ilRbacReview::_getOperationIdsByName(array('visible','read')), $this->ref_id);
                // $rbacadmin->setRolePermission($role->getId(), ilObject::_lookupType($this->ref_id, true), [2,3], $this->ref_id);
                if ($type == "sahs" || $type == "lm" || $type == "svy" || $type == "tst") {
                    $role = new ilObjRole();
                    $role->setTitle("il_lti_instructor");
                    $role->setDescription("LTI Instructor of " . $type . " obj_no." . ilObject::_lookupObjectId($this->ref_id));
                    $role->create();
                    $rbacadmin->assignRoleToFolder($role->getId(), $this->ref_id, 'y');
                    $ops = ilRbacReview::_getOperationIdsByName(array('visible','read','read_learning_progress'));
                    if ($type == "svy") {
                        $ops[] = ilRbacReview::_getOperationIdsByName(array('read_results'))[0];
                    }
                    if ($type == "tst") {
                        $ops[] = ilRbacReview::_getOperationIdsByName(array('tst_results'))[0];
                        $ops[] = ilRbacReview::_getOperationIdsByName(array('tst_statistics'))[0];
                    }
                    $rbacadmin->grantPermission($role->getId(), $ops, $this->ref_id);
                }
            }
        }
    }

References $DIC, $type, ilObject\_getIdsForTitle(), ilRbacReview\_getOperationIdsByName(), ilObject\_lookupObjectId(), and ilObject\_lookupType().

Referenced by setCustomRolesForSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilLTIProviderObjectSettingGUI::executeCommand ( )

Ctrl execute command.

Definition at line 112 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 291 of file class.ilLTIProviderObjectSettingGUI.php.

    {
        $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;
    }

References ilObjRole\_getTranslation(), and ilObject\_lookupTitle().

Referenced by initObjectSettingsForm().

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.

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

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

Here is the call graph for this function:

◆ initObjectSettingsForm()

ilLTIProviderObjectSettingGUI::initObjectSettingsForm ( )

protected

Init object settings form.

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

    {
        $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;
    }

References $GLOBALS, $section, $url, ilObject\_lookupType(), ilLTIToolConsumer\fromGlobalSettingsAndRefId(), getRoleSelection(), and ILIAS_HTTP_PATH.

Referenced by settings(), and updateSettings().

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 103 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 267 of file class.ilLTIProviderObjectSettingGUI.php.

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

References ilPropertyFormGUI\getInput().

Referenced by updateSettings().

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.

    {
        if (empty($a_roles)) {
            $this->checkLocalRole();
            $a_roles = $GLOBALS['DIC']->rbac()->review()->getLocalRoles($this->ref_id);
        }
        $this->custom_roles = $a_roles;
    }

References $GLOBALS, and checkLocalRole().

Here is the call graph for this function:

◆ settings()

ilLTIProviderObjectSettingGUI::settings ( ilPropertyFormGUI $form = null )

protected

Show settings.

Parameters

ilPropertyFormGUI $form

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

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

References initObjectSettingsForm().

Referenced by updateSettings().

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 221 of file class.ilLTIProviderObjectSettingGUI.php.

    {
        $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');
    }