The tab of an ILIAS object that releases it to the platforms allowed for its type, with the local roles the users of each platform get. More...

Collaboration diagram for ilLTIProviderObjectSettingGUI:

Public Member Functions
	__construct (private readonly int $ref_id)

	hasSettingsAccess ()
	True when the object can be released to some platform and the user may release objects. More...

	setCustomRolesForSelection (array $role_ids)
	An object without local roles gets LTI roles of its own, when the administration has created the global LTI role. More...

	offerLTIRolesForSelection (bool $offer)
	Kept for the objects that call it, the roles offered are always the ones given above. More...

	executeCommand ()

Data Fields
const string	CMD_SHOW = 'settings'

const string	CMD_SAVE = 'updateSettings'

Private Member Functions
	show (?Form $form=null)

	save ()

	buildForm ()
	One optional group per platform: releasing the object to it and the roles its users get. More...

	getPlatforms ()
	The platforms the object can be released to. More...

	isAdvantage (int $platform_id)
	An LTI Advantage platform is registered once for all the objects released to it, so releasing an object only sets the roles. More...

	createLocalRoles ()

	createLocalRole (string $title, string $description, string $type, array $operations)

Private Attributes
readonly ILIAS DI Container	$dic

array	$roles = []

Detailed Description

The tab of an ILIAS object that releases it to the platforms allowed for its type, with the local roles the users of each platform get.

The name and the methods are fixed: the objects that can be released (courses, groups, tests, ...) create this class, add its tab and forward to it.

Author: Saúl Díaz sdiaz.nosp@m.@sur.nosp@m.labs..nosp@m.com

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIProviderObjectSettingGUI::__construct ( private readonly int $ref_id )

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

    {
        global $DIC;
 
        $this->dic = $DIC;
        $this->dic->language()->loadLanguageModule('lti');
    }

References $DIC.

Member Function Documentation

◆ buildForm()

ilLTIProviderObjectSettingGUI::buildForm ( )

private

One optional group per platform: releasing the object to it and the roles its users get.

Exceptions

ilCtrlException

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

                                : Form
    {
        $lng = $this->dic->language();
        $factory = $this->dic->ui()->factory();
        $field = $factory->input()->field();
 
        $options = [];
        foreach ($this->roles as $role_id) {
            $options[(string) $role_id] = ilObjRole::_getTranslation(ilObjRole::_lookupTitle((int) $role_id));
        }
 
        $inputs = [];
        foreach ($this->getPlatforms() as $platform_id => $title) {
            $release = new ilLTIRelease($this->ref_id, $platform_id);
            $role = fn(string $txt, int $value) => $field->select($lng->txt($txt), $options)
                ->withValue(isset($options[(string) $value]) ? (string) $value : null);
            $roles = [
                'admin' => $role('lti_admin', $release->getAdminRole()),
                'tutor' => $role('lti_tutor', $release->getTutorRole()),
                'member' => $role('lti_member', $release->getMemberRole()),
            ];
 
            if ($this->isAdvantage($platform_id)) {
                // the target link the platform launches the object with, see ilAuthProviderLTI
                $group = $field->optionalGroup($roles + [
                    'launch_url' => $field->text($lng->txt('lti_launch_url'))
                        ->withValue(ilLTIEndpoint::getUrl(ilLTIEndpoint::LAUNCH, '?ref_id=' . $this->ref_id))
                        ->withDisabled(true),
                ], $title);
                $inputs['platform_' . $platform_id] = $release->isReleased() ? $group : $group->withValue(null);
                continue;
            }
 
            $credentials = new ilLTI1p1ProviderObjectCredentials($this->ref_id, $platform_id);
            $group = $field->optionalGroup($roles + $credentials->getInputs($lng, $factory), $title);
            $inputs['platform_' . $platform_id] = $credentials->isEnabled() ? $group : $group->withValue(null);
        }
 
        return $factory->input()->container()->form()->standard(
            $this->dic->ctrl()->getFormAction($this, self::CMD_SAVE),
            ['platforms' => $factory->input()->field()->section($inputs, $lng->txt('lti_object_release_settings_form'))]
        );
    }

References ILIAS\UI\Implementation\Component\Input\$inputs, $lng, ILIAS\UI\Implementation\Component\Input\Field\$options, $roles, ilObjRole\_getTranslation(), ilObject\_lookupTitle(), getPlatforms(), ilLTIEndpoint\getUrl(), isAdvantage(), and ilLTIEndpoint\LAUNCH.

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createLocalRole()

ilLTIProviderObjectSettingGUI::createLocalRole	(	string	$title,
		string	$description,
		string	$type,
		array	$operations
	)

private

Parameters

string	$title
string	$description
string	$type
array	$operations

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

                                                                                                         : void
    {
        $role = new ilObjRole();
        $role->setTitle($title);
        $role->setDescription($description . ' of ' . $type . ' obj_no.' . ilObject::_lookupObjectId($this->ref_id));
        $role->create();
 
        $this->dic->rbac()->admin()->assignRoleToFolder($role->getId(), $this->ref_id);
        $this->dic->rbac()->admin()->grantPermission(
            $role->getId(),
            ilRbacReview::_getOperationIdsByName($operations),
            $this->ref_id
        );
    }

References ilRbacReview\_getOperationIdsByName(), and ilObject\_lookupObjectId().

Referenced by createLocalRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createLocalRoles()

ilLTIProviderObjectSettingGUI::createLocalRoles ( )

private

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

                                       : void
    {
        if (ilObject::_getIdsForTitle('il_lti_global_role', 'role') === []
            || $this->dic->rbac()->review()->getRolesOfObject($this->ref_id) !== []) {
            return;
        }
 
        $type = ilObject::_lookupType($this->ref_id, true);
        $this->createLocalRole('il_lti_learner', 'LTI Learner', $type, ['visible', 'read']);
 
        if (in_array($type, ['sahs', 'lm', 'svy', 'tst'], true)) {
            $operations = ['visible', 'read', 'read_learning_progress'];
            if ($type === 'svy') {
                $operations[] = 'read_results';
            }
            if ($type === 'tst') {
                $operations[] = 'tst_results';
            }
            $this->createLocalRole('il_lti_instructor', 'LTI Instructor', $type, $operations);
        }
    }

References ilObject\_getIdsForTitle(), ilObject\_lookupType(), and createLocalRole().

Referenced by setCustomRolesForSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilLTIProviderObjectSettingGUI::executeCommand ( )

Exceptions

ilCtrlException

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

                                    : void
    {
        if (!$this->hasSettingsAccess()) {
            $this->dic->ui()->mainTemplate()->setOnScreenMessage('failure', $this->dic->language()->txt('permission_denied'), true);
            $this->dic->ctrl()->redirectByClass(ilRepositoryGUI::class);
        }
 
        match ($this->dic->ctrl()->getCmd(self::CMD_SHOW)) {
            self::CMD_SAVE => $this->save(),
            default => $this->show(),
        };
    }

References hasSettingsAccess(), save(), and show().

Here is the call graph for this function:

◆ getPlatforms()

ilLTIProviderObjectSettingGUI::getPlatforms ( )

private

The platforms the object can be released to.

Returns: array titles by id

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

                                   : array
    {
        return ilLTIRelease::getPlatformsForType(ilObject::_lookupType($this->ref_id, true));
    }

References ilObject\_lookupType(), and ilLTIRelease\getPlatformsForType().

Referenced by buildForm(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSettingsAccess()

ilLTIProviderObjectSettingGUI::hasSettingsAccess ( )

True when the object can be released to some platform and the user may release objects.

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

                                       : bool
    {
        $admin_ref_id = ilObjLTIAdministrationAccess::lookupRefId();
 
        return $admin_ref_id !== null
            && ilLTIRelease::getPlatformsForType(ilObject::_lookupType($this->ref_id, true)) !== []
            && $this->dic->rbac()->system()->checkAccess('release_objects', $admin_ref_id);
    }

References ilObject\_lookupType(), ilLTIRelease\getPlatformsForType(), and ilObjLTIAdministrationAccess\lookupRefId().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAdvantage()

ilLTIProviderObjectSettingGUI::isAdvantage ( int $platform_id )

private

An LTI Advantage platform is registered once for all the objects released to it, so releasing an object only sets the roles.

An LTI 1.1 platform gets a registration with a key and secret per object. Earlier releases let each object choose, so an object that has a registration of its own keeps its version, whatever the other objects of the platform use.

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

                                                  : bool
    {
        $db = $this->dic->database();
        $db->setLimit(1);
        $own = $db->fetchAssoc($db->queryF(
            'SELECT lti_version FROM lti2_consumer WHERE ext_consumer_id = %s AND ref_id = %s ORDER BY consumer_pk DESC',
            ['integer', 'integer'],
            [$platform_id, $this->ref_id]
        ));
        $version = $own !== null
            ? (string) $own['lti_version']
            : ilLTIPlatform::lookupVersion($platform_id);
 
        return $version === ilLTITool::VERSION_ADVANTAGE;
    }

References $version, ilLTIPlatform\lookupVersion(), and ilLTITool\VERSION_ADVANTAGE.

Referenced by buildForm(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ offerLTIRolesForSelection()

ilLTIProviderObjectSettingGUI::offerLTIRolesForSelection ( bool $offer )

Kept for the objects that call it, the roles offered are always the ones given above.

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

                                                          : void
    {
    }

◆ save()

ilLTIProviderObjectSettingGUI::save ( )

private

Exceptions

ilCtrlException

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

                           : void
    {
        $form = $this->buildForm()->withRequest($this->dic->http()->request());
        $data = $form->getData();
        if ($data === null) {
            $this->show($form);
            return;
        }
 
        foreach ($this->getPlatforms() as $platform_id => $title) {
            $release = $data['platforms']['platform_' . $platform_id] ?? null;
            if ($release !== null) {
                new ilLTIRelease($this->ref_id, $platform_id)->save(
                    (int) $release['admin'],
                    (int) $release['tutor'],
                    (int) $release['member']
                );
            }
            if ($this->isAdvantage($platform_id)) {
                if ($release === null) {
                    new ilLTIRelease($this->ref_id, $platform_id)->delete();
                }
                continue;
            }
            new ilLTI1p1ProviderObjectCredentials($this->ref_id, $platform_id)->save($release ?? [], $release !== null);
        }
 
        $this->dic->ui()->mainTemplate()->setOnScreenMessage('success', $this->dic->language()->txt('settings_saved'), true);
        $this->dic->ctrl()->redirect($this, self::CMD_SHOW);
    }

References $data, buildForm(), ilLTIRelease\delete(), getPlatforms(), isAdvantage(), ilLTI1p1ProviderObjectCredentials\save(), ilLTIRelease\save(), and show().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCustomRolesForSelection()

ilLTIProviderObjectSettingGUI::setCustomRolesForSelection ( array $role_ids )

An object without local roles gets LTI roles of its own, when the administration has created the global LTI role.

Parameters

array $role_ids

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

                                                               : void
    {
        if ($role_ids === []) {
            $this->createLocalRoles();
            $role_ids = $this->dic->rbac()->review()->getLocalRoles($this->ref_id);
        }
        $this->roles = $role_ids;
    }

References createLocalRoles().

Here is the call graph for this function:

◆ show()

ilLTIProviderObjectSettingGUI::show ( ?Form $form = null )

private

Exceptions

ilCtrlException

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

                                             : void
    {
        $this->dic->ui()->mainTemplate()->setContent($this->dic->ui()->renderer()->render($form ?? $this->buildForm()));
    }

Referenced by executeCommand(), and save().

Here is the caller graph for this function: