Collaboration diagram for ilSamlSettingsGUI:

Public Member Functions
	__construct (int $ref_id)

	getRefId ()

	executeCommand ()

Data Fields
const	DEFAULT_CMD = 'listIdps'

Protected Member Functions
	ensureAccess (string $operation)

	ensureWriteAccess ()

	ensureReadAccess ()

	initIdp ()

	listIdps ()

	deactivateIdp ()

	activateIdp ()

	setSubTabs (int $a_view_mode)

	getUserAttributeMappingForm ()

	addAttributeRuleFieldToForm (ilPropertyFormGUI $form, string $field_label, string $field_name)

	saveUserAttributeMapping ()

	showUserAttributeMappingForm (ilPropertyFormGUI $form=null)

	getSettingsForm ()

	saveSettings ()

	showSettings (ilPropertyFormGUI $form=null)

	getIdpSettingsForm ()

	showIdpSettings (ilPropertyFormGUI $form=null)

	saveIdpSettings ()

	getIdpForm ()

	saveNewIdp ()

	showNewIdpForm (ilPropertyFormGUI $form=null)

	addMetadataElement (ilPropertyFormGUI $form)

	populateWithMetadata (ilSamlIdp $idp, array &$data)

	storeMetadata (ilSamlIdp $idp, string $metadata)

	confirmDeleteIdp ()

	deleteIdp ()

Protected Attributes
int	$ref_id

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilAccessHandler	$access

RBACServices	$rbac

ilErrorHandling	$error_handler

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

GlobalHttpState	$httpState

Refinery	$refinery

ilHelpGUI	$help

ilExternalAuthUserAttributeMapping	$mapping = null

ilSamlIdp	$idp = null

ilSamlAuth	$samlAuth = null

Static Protected Attributes
static array	$globalCommands

static array	$globalEntityCommands

static array	$ignoredUserFields

Private Member Functions
	getIdpIdOrZero ()

	initUserAttributeMapping ()

	prepareRoleSelection ()

Private Attributes
const	VIEW_MODE_GLOBAL = 1

const	VIEW_MODE_SINGLE = 2

Detailed Description

Class ilSamlSettingsGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 30 of file class.ilSamlSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSamlSettingsGUI::__construct ( int $ref_id )

Definition at line 98 of file class.ilSamlSettingsGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->rbac = $DIC->rbac();
        $this->error_handler = $DIC['ilErr'];
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC['ilToolbar'];
        $this->help = $DIC['ilHelp'];
        $this->httpState = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        $this->lng->loadLanguageModule('auth');
        $this->ref_id = $ref_id;
    }

References $DIC, $ref_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ activateIdp()

ilSamlSettingsGUI::activateIdp ( )

protected

Definition at line 249 of file class.ilSamlSettingsGUI.php.

                                    : void
    {
        $this->ensureWriteAccess();
 
        $this->idp->setActive(true);
        $this->idp->persist();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        $this->listIdps();
    }

References ensureWriteAccess(), listIdps(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ addAttributeRuleFieldToForm()

ilSamlSettingsGUI::addAttributeRuleFieldToForm	(	ilPropertyFormGUI	$form,
		string	$field_label,
		string	$field_name
	)

protected

Definition at line 338 of file class.ilSamlSettingsGUI.php.

     : void {
        $field = new ilTextInputGUI($field_label, $field_name);
        $form->addItem($field);
 
        $update_automatically = new ilCheckboxInputGUI('', $field_name . '_update');
        $update_automatically->setOptionTitle($this->lng->txt('auth_saml_update_field_info'));
        $update_automatically->setValue('1');
        $form->addItem($update_automatically);
    }

Referenced by getUserAttributeMappingForm().

Here is the caller graph for this function:

◆ addMetadataElement()

ilSamlSettingsGUI::addMetadataElement ( ilPropertyFormGUI $form )

protected

Definition at line 614 of file class.ilSamlSettingsGUI.php.

                                                                  : void
    {
        $metadata = new ilSamlIdpMetadataInputGUI(
            $this->lng->txt('auth_saml_add_idp_md_label'),
            'metadata',
            new ilSamlIdpXmlMetadataParser(
                new Factory(),
                new ilSamlIdpXmlMetadataErrorFormatter()
            )
        );
        $metadata->setInfo($this->lng->txt('auth_saml_add_idp_md_info'));
        $metadata->setRows(20);
        $metadata->setRequired(true);
 
        $purifier = new ilHtmlPurifierComposite();
        $purifier->addPurifier(new ilSamlIdpMetadataPurifier());
 
        $metadata->setPurifier($purifier);
        $metadata->usePurifier(true);
        $form->addItem($metadata);
    }

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ confirmDeleteIdp()

ilSamlSettingsGUI::confirmDeleteIdp ( )

protected

Definition at line 649 of file class.ilSamlSettingsGUI.php.

                                         : void
    {
        $this->ensureWriteAccess();
 
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'deleteIdp'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'deleteIdp');
        $confirmation->setCancel($this->lng->txt('cancel'), self::DEFAULT_CMD);
        $confirmation->setHeaderText($this->lng->txt('auth_saml_sure_delete_idp'));
        $confirmation->addItem('saml_idp_ids', (string) $this->idp->getIdpId(), $this->idp->getEntityId());
 
        $this->tpl->setContent($confirmation->getHTML());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ deactivateIdp()

ilSamlSettingsGUI::deactivateIdp ( )

protected

Definition at line 238 of file class.ilSamlSettingsGUI.php.

                                      : void
    {
        $this->ensureWriteAccess();
 
        $this->idp->setActive(false);
        $this->idp->persist();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        $this->listIdps();
    }

References ensureWriteAccess(), listIdps(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ deleteIdp()

ilSamlSettingsGUI::deleteIdp ( )

protected

Definition at line 663 of file class.ilSamlSettingsGUI.php.

                                  : void
    {
        $this->ensureWriteAccess();
 
        $idpDisco = $this->samlAuth->getIdpDiscovery();
        $idpDisco->deleteIdpMetadata($this->idp->getIdpId());
 
        $this->idp->delete();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('auth_saml_deleted_idp'), true);
 
        $this->ctrl->setParameter($this, 'saml_idp_id', null);
        $this->ctrl->redirect($this, self::DEFAULT_CMD);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ ensureAccess()

ilSamlSettingsGUI::ensureAccess ( string $operation )

protected

Definition at line 118 of file class.ilSamlSettingsGUI.php.

                                                      : void
    {
        if (!$this->rbac->system()->checkAccess($operation, $this->getRefId())) {
            $this->error_handler->raiseError($this->lng->txt('msg_no_perm_read'), $this->error_handler->WARNING);
        }
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

Referenced by ensureReadAccess(), and ensureWriteAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureReadAccess()

ilSamlSettingsGUI::ensureReadAccess ( )

protected

Definition at line 130 of file class.ilSamlSettingsGUI.php.

                                         : void
    {
        $this->ensureAccess('read');
    }

References ensureAccess().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureWriteAccess()

ilSamlSettingsGUI::ensureWriteAccess ( )

protected

Definition at line 125 of file class.ilSamlSettingsGUI.php.

                                          : void
    {
        $this->ensureAccess('write');
    }

References ensureAccess().

Referenced by activateIdp(), and deactivateIdp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSamlSettingsGUI::executeCommand ( )

Definition at line 169 of file class.ilSamlSettingsGUI.php.

                                    : void
    {
        $this->ensureReadAccess();
 
        try {
            $factory = new ilSamlAuthFactory();
            $this->samlAuth = $factory->auth();
        } catch (Throwable $e) {
            if ('Database error: could not find driver' === $e->getMessage()) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('auth_saml_err_sqlite_driver'));
            } else {
                $this->tpl->setOnScreenMessage('failure', $e->getMessage());
            }
        }
 
        $this->help->setScreenIdComponent('auth');
 
        switch ($this->ctrl->getNextClass()) {
            default:
                $cmd = $this->ctrl->getCmd();
                if ($cmd === null || $cmd === '' || !method_exists($this, $cmd)) {
                    $cmd = self::DEFAULT_CMD;
                }
 
                $ipdId = $this->getIdpIdOrZero();
                if ($ipdId > 0) {
                    $this->ctrl->saveParameter($this, 'saml_idp_id');
                }
 
                if (!in_array(strtolower($cmd), array_map('strtolower', self::$globalCommands), true)) {
                    if (0 === $ipdId) {
                        $this->ctrl->redirect($this, self::DEFAULT_CMD);
                    }
 
                    $this->initIdp();
                    $this->initUserAttributeMapping();
                }
 
                if (
                    in_array(strtolower($cmd), array_map('strtolower', self::$globalCommands), true) ||
                    in_array(strtolower($cmd), array_map('strtolower', self::$globalEntityCommands), true)
                ) {
                    $this->setSubTabs(self::VIEW_MODE_GLOBAL);
                } else {
                    $this->setSubTabs(self::VIEW_MODE_SINGLE);
                }
 
                $this->$cmd();
                break;
        }
    }

References Vendor\Package\$e, $factory, ILIAS\Repository\ctrl(), DEFAULT_CMD, ensureReadAccess(), getIdpIdOrZero(), ILIAS\Repository\help(), initIdp(), initUserAttributeMapping(), ILIAS\Repository\lng(), and setSubTabs().

Here is the call graph for this function:

◆ getIdpForm()

ilSamlSettingsGUI::getIdpForm ( )

protected

Definition at line 565 of file class.ilSamlSettingsGUI.php.

                                   : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveNewIdp'));
        $form->setTitle($this->lng->txt('auth_saml_add_idp_btn'));
 
        $this->addMetadataElement($form);
 
        $form->addCommandButton('saveNewIdp', $this->lng->txt('save'));
        $form->addCommandButton('listIdps', $this->lng->txt('cancel'));
 
        return $form;
    }

References ilPropertyFormGUI\addCommandButton(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Here is the call graph for this function:

◆ getIdpIdOrZero()

ilSamlSettingsGUI::getIdpIdOrZero ( )

private

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

                                     : int
    {
        $idpId = 0;
        if ($this->httpState->wrapper()->query()->has('saml_idp_id')) {
            $idpId = (int) $this->httpState->wrapper()->query()->retrieve(
                'saml_idp_id',
                $this->refinery->kindlyTo()->int()
            );
        } elseif ($this->httpState->wrapper()->post()->has('saml_idp_id')) {
            $idpId = (int) $this->httpState->wrapper()->post()->retrieve(
                'saml_idp_id',
                $this->refinery->kindlyTo()->int()
            );
        }
 
        return $idpId;
    }

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

Referenced by executeCommand(), and initIdp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdpSettingsForm()

ilSamlSettingsGUI::getIdpSettingsForm ( )

protected

Definition at line 477 of file class.ilSamlSettingsGUI.php.

                                           : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveIdpSettings'));
        $form->setTitle(sprintf($this->lng->txt('auth_saml_configure_idp'), $this->idp->getEntityId()));
 
        $idp = new ilTextInputGUI($this->lng->txt('auth_saml_idp'), 'entity_id');
        $idp->setDisabled(true);
        $form->addItem($idp);
 
        $this->addMetadataElement($form);
 
        $local = new ilCheckboxInputGUI($this->lng->txt('auth_allow_local'), 'allow_local_auth');
        $local->setValue('1');
        $local->setInfo($this->lng->txt('auth_allow_local_info'));
        $form->addItem($local);
 
        $uid_claim = new ilTextInputGUI($this->lng->txt('auth_saml_uid_claim'), 'uid_claim');
        $uid_claim->setInfo($this->lng->txt('auth_saml_uid_claim_info'));
        $uid_claim->setRequired(true);
        $form->addItem($uid_claim);
 
        $sync = new ilCheckboxInputGUI($this->lng->txt('auth_saml_sync'), 'sync_status');
        $sync->setInfo($this->lng->txt('auth_saml_sync_info'));
        $sync->setValue('1');
 
        $username_claim = new ilTextInputGUI($this->lng->txt('auth_saml_username_claim'), 'login_claim');
        $username_claim->setInfo($this->lng->txt('auth_saml_username_claim_info'));
        $username_claim->setRequired(true);
        $sync->addSubItem($username_claim);
 
        $role = new ilSelectInputGUI($this->lng->txt('auth_saml_role_select'), 'default_role_id');
        $role->setOptions($this->prepareRoleSelection());
        $role->setRequired(true);
        $sync->addSubItem($role);
 
        $migr = new ilCheckboxInputGUI($this->lng->txt('auth_saml_migration'), 'account_migr_status');
        $migr->setInfo($this->lng->txt('auth_saml_migration_info'));
        $migr->setValue('1');
        $sync->addSubItem($migr);
        $form->addItem($sync);
 
        if (!$this->access->checkAccess('write', '', $this->getRefId())) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton('saveIdpSettings', $this->lng->txt('save'));
        }
        $form->addCommandButton(self::DEFAULT_CMD, $this->lng->txt('cancel'));
 
        return $form;
    }

References ILIAS\Repository\access(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getItems(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Here is the call graph for this function:

◆ getRefId()

ilSamlSettingsGUI::getRefId ( )

Definition at line 135 of file class.ilSamlSettingsGUI.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

◆ getSettingsForm()

ilSamlSettingsGUI::getSettingsForm ( )

protected

Definition at line 408 of file class.ilSamlSettingsGUI.php.

                                        : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveSettings'));
        $form->setTitle($this->lng->txt('auth_saml_configure'));
 
        $show_login_form = new ilCheckboxInputGUI($this->lng->txt('auth_saml_login_form'), 'login_form');
        $show_login_form->setInfo($this->lng->txt('auth_saml_login_form_info'));
        $show_login_form->setValue('1');
        $form->addItem($show_login_form);
 
        if (!$this->access->checkAccess('write', '', $this->getRefId())) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
        }
 
        return $form;
    }

References ILIAS\Repository\access(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getItems(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Here is the call graph for this function:

◆ getUserAttributeMappingForm()

ilSamlSettingsGUI::getUserAttributeMappingForm ( )

protected

Definition at line 308 of file class.ilSamlSettingsGUI.php.

                                                    : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveUserAttributeMapping'));
        $form->setTitle($this->lng->txt('auth_saml_user_mapping'));
 
        $usr_profile = new ilUserProfile();
        foreach ($usr_profile->getStandardFields() as $id => $definition) {
            if (in_array($id, self::$ignoredUserFields, true)) {
                continue;
            }
 
            $this->addAttributeRuleFieldToForm($form, $this->lng->txt($id), $id);
        }
 
        foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
            $this->addAttributeRuleFieldToForm($form, $definition['field_name'], 'udf_' . $definition['field_id']);
        }
 
        if (!$this->access->checkAccess('write', '', $this->getRefId())) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton('saveUserAttributeMapping', $this->lng->txt('save'));
        }
 
        return $form;
    }

References $id, ilUserDefinedFields\_getInstance(), ILIAS\Repository\access(), addAttributeRuleFieldToForm(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ initIdp()

ilSamlSettingsGUI::initIdp ( )

protected

Definition at line 158 of file class.ilSamlSettingsGUI.php.

                                : void
    {
        try {
            $this->idp = ilSamlIdp::getInstanceByIdpId($this->getIdpIdOrZero());
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('auth_saml_unknow_idp'), true);
            $this->ctrl->setParameter($this, 'saml_idp_id', null);
            $this->ctrl->redirect($this, self::DEFAULT_CMD);
        }
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getIdpIdOrZero(), ilSamlIdp\getInstanceByIdpId(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserAttributeMapping()

ilSamlSettingsGUI::initUserAttributeMapping ( )

private

Definition at line 303 of file class.ilSamlSettingsGUI.php.

                                               : void
    {
        $this->mapping = new ilExternalAuthUserAttributeMapping('saml', $this->idp->getIdpId());
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ listIdps()

ilSamlSettingsGUI::listIdps ( )

protected

Definition at line 221 of file class.ilSamlSettingsGUI.php.

                                 : void
    {
        if ($this->samlAuth && $this->rbac->system()->checkAccess('write', $this->ref_id)) {
            $addIdpButton = ilLinkButton::getInstance();
            $addIdpButton->setCaption('auth_saml_add_idp_btn');
            $addIdpButton->setUrl($this->ctrl->getLinkTarget($this, 'showNewIdpForm'));
            $this->toolbar->addStickyItem($addIdpButton);
        }
 
        $table = new ilSamlIdpTableGUI(
            $this,
            self::DEFAULT_CMD,
            $this->rbac->system()->checkAccess('write', $this->getRefId())
        );
        $this->tpl->setContent($table->getHTML());
    }

References ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\rbac(), and ILIAS\Repository\toolbar().

Referenced by activateIdp(), and deactivateIdp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateWithMetadata()

ilSamlSettingsGUI::populateWithMetadata	(	ilSamlIdp	$idp,
		array &	$data
	)

protected

Definition at line 636 of file class.ilSamlSettingsGUI.php.

                                                                         : void
    {
        $idpDisco = $this->samlAuth->getIdpDiscovery();
 
        $data['metadata'] = $idpDisco->fetchIdpMetadata($idp->getIdpId());
    }

References $data, and ilSamlIdp\getIdpId().

Here is the call graph for this function:

◆ prepareRoleSelection()

ilSamlSettingsGUI::prepareRoleSelection ( )

private

Returns: array<int, string>

Definition at line 433 of file class.ilSamlSettingsGUI.php.

                                           : array
    {
        $global_roles = array_map('intval', ilUtil::_sortIds(
            $this->rbac->review()->getGlobalRoles(),
            'object_data',
            'title',
            'obj_id'
        ));
 
        $select[0] = $this->lng->txt('links_select_one');
        foreach ($global_roles as $role_id) {
            $select[$role_id] = ilObject::_lookupTitle($role_id);
        }
 
        return $select;
    }

References ilObject\_lookupTitle(), ilUtil\_sortIds(), ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

Here is the call graph for this function:

◆ saveIdpSettings()

ilSamlSettingsGUI::saveIdpSettings ( )

protected

Definition at line 549 of file class.ilSamlSettingsGUI.php.

                                        : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getIdpSettingsForm();
        if ($form->checkInput()) {
            $this->idp->bindForm($form);
            $this->idp->persist();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
 
            $this->storeMetadata($this->idp, $form->getInput('metadata'));
        }
 
        $this->showIdpSettings($form);
    }

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveNewIdp()

ilSamlSettingsGUI::saveNewIdp ( )

protected

Definition at line 579 of file class.ilSamlSettingsGUI.php.

                                   : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getIdpForm();
        if ($form->checkInput()) {
            $idp = new ilSamlIdp();
            $idp->bindForm($form);
            $idp->persist();
 
            $this->storeMetadata($idp, $form->getInput('metadata'));
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            $this->ctrl->setParameter($this, 'saml_idp_id', $idp->getIdpId());
            $this->ctrl->redirect($this, 'showIdpSettings');
        }
 
        $this->showNewIdpForm($form);
    }

References ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilSamlIdp\getIdpId(), ilPropertyFormGUI\getInput(), ILIAS\Repository\lng(), and ilSamlIdp\persist().

Here is the call graph for this function:

◆ saveSettings()

ilSamlSettingsGUI::saveSettings ( )

protected

Definition at line 450 of file class.ilSamlSettingsGUI.php.

                                     : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getSettingsForm();
        if ($form->checkInput()) {
            ilSamlSettings::getInstance()->setLoginFormStatus((bool) $form->getInput('login_form'));
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }
 
        $form->setValuesByPost();
 
        $this->showSettings($form);
    }

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilSamlSettings\getInstance(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveUserAttributeMapping()

ilSamlSettingsGUI::saveUserAttributeMapping ( )

protected

Definition at line 352 of file class.ilSamlSettingsGUI.php.

                                                 : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getUserAttributeMappingForm();
        if ($form->checkInput()) {
            $this->mapping->delete();
 
            $usr_profile = new ilUserProfile();
            foreach ($usr_profile->getStandardFields() as $id => $definition) {
                if (in_array($id, self::$ignoredUserFields, true)) {
                    continue;
                }
 
                $rule = $this->mapping->getEmptyRule();
                $rule->setAttribute($id);
                $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . '_update'));
                $this->mapping[$rule->getAttribute()] = $rule;
            }
 
            foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
                $rule = $this->mapping->getEmptyRule();
                $rule->setAttribute('udf_' . $definition['field_id']);
                $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . '_update'));
                $this->mapping[$rule->getAttribute()] = $rule;
            }
 
            $this->mapping->save();
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }
 
        $form->setValuesByPost();
 
        $this->showUserAttributeMappingForm($form);
    }

References $id, ilUserDefinedFields\_getInstance(), ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ setSubTabs()

ilSamlSettingsGUI::setSubTabs ( int $a_view_mode )

protected

Definition at line 260 of file class.ilSamlSettingsGUI.php.

                                                   : void
    {
        switch ($a_view_mode) {
            case self::VIEW_MODE_GLOBAL:
                $this->tabs->addSubTabTarget(
                    'auth_saml_idps',
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD),
                    array_merge(self::$globalEntityCommands, [self::DEFAULT_CMD, 'showNewIdpForm', 'saveNewIdp']),
                    self::class
                );
 
                $this->tabs->addSubTabTarget(
                    'settings',
                    $this->ctrl->getLinkTarget($this, 'showSettings'),
                    ['showSettings', 'saveSettings'],
                    self::class
                );
                break;
 
            case self::VIEW_MODE_SINGLE:
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD)
                );
 
                $this->tabs->addSubTabTarget(
                    'auth_saml_idp_settings',
                    $this->ctrl->getLinkTarget($this, 'showIdpSettings'),
                    ['showIdpSettings', 'saveIdpSettings'],
                    self::class
                );
 
                $this->tabs->addSubTabTarget(
                    'auth_saml_user_mapping',
                    $this->ctrl->getLinkTarget($this, 'showUserAttributeMappingForm'),
                    ['showUserAttributeMappingForm', 'saveUserAttributeMapping'],
                    self::class
                );
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), VIEW_MODE_GLOBAL, and VIEW_MODE_SINGLE.

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showIdpSettings()

ilSamlSettingsGUI::showIdpSettings ( ilPropertyFormGUI $form = null )

protected

Definition at line 531 of file class.ilSamlSettingsGUI.php.

                                                                      : void
    {
        $this->tabs->setSubTabActive('auth_saml_idp_settings');
 
        if (null === $form) {
            $form = $this->getIdpSettingsForm();
            $data = $this->idp->toArray();
            $this->populateWithMetadata($this->idp, $data);
            $form->setValuesByArray($data);
        } else {
            $form->setValuesByPost();
        }
 
        $this->help->setSubScreenId('edit_idp');
 
        $this->tpl->setContent($form->getHTML());
    }

References $data, ilPropertyFormGUI\getHTML(), ILIAS\Repository\help(), ilPropertyFormGUI\setValuesByArray(), ilPropertyFormGUI\setValuesByPost(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ showNewIdpForm()

ilSamlSettingsGUI::showNewIdpForm ( ilPropertyFormGUI $form = null )

protected

Definition at line 599 of file class.ilSamlSettingsGUI.php.

                                                                     : void
    {
        $this->ensureWriteAccess();
 
        if (null === $form) {
            $form = $this->getIdpForm();
        } else {
            $form->setValuesByPost();
        }
 
        $this->help->setSubScreenId('create_idp');
 
        $this->tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\getHTML(), ILIAS\Repository\help(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ showSettings()

ilSamlSettingsGUI::showSettings ( ilPropertyFormGUI $form = null )

protected

Definition at line 465 of file class.ilSamlSettingsGUI.php.

                                                                   : void
    {
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getSettingsForm();
            $form->setValuesByArray([
                'login_form' => ilSamlSettings::getInstance()->isDisplayedOnLoginPage(),
            ]);
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\getHTML(), ilSamlSettings\getInstance(), and ilPropertyFormGUI\setValuesByArray().

Here is the call graph for this function:

◆ showUserAttributeMappingForm()

ilSamlSettingsGUI::showUserAttributeMappingForm ( ilPropertyFormGUI $form = null )

protected

Definition at line 391 of file class.ilSamlSettingsGUI.php.

                                                                                   : void
    {
        $this->tabs->setSubTabActive('auth_saml_user_mapping');
 
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getUserAttributeMappingForm();
            $data = array();
            foreach ($this->mapping as $rule) {
                $data[$rule->getAttribute()] = $rule->getExternalAttribute();
                $data[$rule->getAttribute() . '_update'] = $rule->isAutomaticallyUpdated();
            }
            $form->setValuesByArray($data);
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $data, ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\setValuesByArray(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ storeMetadata()

ilSamlSettingsGUI::storeMetadata	(	ilSamlIdp	$idp,
		string	$metadata
	)

protected

Definition at line 643 of file class.ilSamlSettingsGUI.php.

                                                                      : void
    {
        $idpDisco = $this->samlAuth->getIdpDiscovery();
        $idpDisco->storeIdpMetadata($idp->getIdpId(), $metadata);
    }

References ilSamlIdp\getIdpId().

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilSamlSettingsGUI::$access

protected

Definition at line 86 of file class.ilSamlSettingsGUI.php.

◆ $ctrl

ilCtrlInterface ilSamlSettingsGUI::$ctrl

protected

Definition at line 83 of file class.ilSamlSettingsGUI.php.

◆ $error_handler

ilErrorHandling ilSamlSettingsGUI::$error_handler

protected

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

◆ $globalCommands

array ilSamlSettingsGUI::$globalCommands

staticprotected

Initial value:

= [
        self::DEFAULT_CMD,
        'showAddIdpForm',
        'showSettings',
        'saveSettings',
        'showNewIdpForm',
        'saveNewIdp',
    ]

Definition at line 40 of file class.ilSamlSettingsGUI.php.

◆ $globalEntityCommands

array ilSamlSettingsGUI::$globalEntityCommands

staticprotected

Initial value:

= [
        'deactivateIdp',
        'activateIdp',
        'confirmDeleteIdp',
        'deleteIdp',
    ]

Definition at line 52 of file class.ilSamlSettingsGUI.php.

◆ $help

ilHelpGUI ilSamlSettingsGUI::$help

protected

Definition at line 93 of file class.ilSamlSettingsGUI.php.

◆ $httpState

GlobalHttpState ilSamlSettingsGUI::$httpState

protected

Definition at line 91 of file class.ilSamlSettingsGUI.php.

◆ $idp

ilSamlIdp ilSamlSettingsGUI::$idp = null

protected

Definition at line 95 of file class.ilSamlSettingsGUI.php.

◆ $ignoredUserFields

array ilSamlSettingsGUI::$ignoredUserFields

staticprotected

Initial value:

= [
        'mail_incoming_mail',
        'preferences',
        'hide_own_online_status',
        'show_users_online',
        'hits_per_page',
        'roles',
        'upload',
        'password',
        'username',
        'language',
        'skin_style',
        'interests_general',
        'interests_help_offered',
        'interests_help_looking',
        'bs_allow_to_contact_me',
        'chat_osc_accept_msg',
        'chat_broadcast_typing',
    ]

Definition at line 62 of file class.ilSamlSettingsGUI.php.

◆ $lng

ilLanguage ilSamlSettingsGUI::$lng

protected

Definition at line 84 of file class.ilSamlSettingsGUI.php.

◆ $mapping

ilExternalAuthUserAttributeMapping ilSamlSettingsGUI::$mapping = null

protected

Definition at line 94 of file class.ilSamlSettingsGUI.php.

◆ $rbac

RBACServices ilSamlSettingsGUI::$rbac

protected

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

◆ $ref_id

int ilSamlSettingsGUI::$ref_id

protected

Definition at line 82 of file class.ilSamlSettingsGUI.php.

Referenced by __construct(), and getRefId().

◆ $refinery

Refinery ilSamlSettingsGUI::$refinery

protected

Definition at line 92 of file class.ilSamlSettingsGUI.php.

◆ $samlAuth

ilSamlAuth ilSamlSettingsGUI::$samlAuth = null

protected

Definition at line 96 of file class.ilSamlSettingsGUI.php.

◆ $tabs

ilTabsGUI ilSamlSettingsGUI::$tabs

protected

Definition at line 89 of file class.ilSamlSettingsGUI.php.

◆ $toolbar

ilToolbarGUI ilSamlSettingsGUI::$toolbar

protected

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

◆ $tpl

ilGlobalTemplateInterface ilSamlSettingsGUI::$tpl

protected

Definition at line 85 of file class.ilSamlSettingsGUI.php.

◆ DEFAULT_CMD

const ilSamlSettingsGUI::DEFAULT_CMD = 'listIdps'

Definition at line 35 of file class.ilSamlSettingsGUI.php.

Referenced by executeCommand(), and ilObjAuthSettingsGUI\getTabs().

◆ VIEW_MODE_GLOBAL

const ilSamlSettingsGUI::VIEW_MODE_GLOBAL = 1

private

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

Referenced by setSubTabs().

◆ VIEW_MODE_SINGLE

const ilSamlSettingsGUI::VIEW_MODE_SINGLE = 2

private

Definition at line 33 of file class.ilSamlSettingsGUI.php.

Referenced by setSubTabs().

The documentation for this class was generated from the following file:

Services/Saml/classes/class.ilSamlSettingsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateIdp()

◆ addAttributeRuleFieldToForm()

◆ addMetadataElement()

◆ confirmDeleteIdp()

◆ deactivateIdp()

◆ deleteIdp()

◆ ensureAccess()

◆ ensureReadAccess()

◆ ensureWriteAccess()

◆ executeCommand()

◆ getIdpForm()

◆ getIdpIdOrZero()

◆ getIdpSettingsForm()

◆ getRefId()

◆ getSettingsForm()

◆ getUserAttributeMappingForm()

◆ initIdp()

◆ initUserAttributeMapping()

◆ listIdps()

◆ populateWithMetadata()

◆ prepareRoleSelection()

◆ saveIdpSettings()

◆ saveNewIdp()

◆ saveSettings()

◆ saveUserAttributeMapping()

◆ setSubTabs()

◆ showIdpSettings()

◆ showNewIdpForm()

◆ showSettings()

◆ showUserAttributeMappingForm()

◆ storeMetadata()

Field Documentation

◆ $access

◆ $ctrl

◆ $error_handler

◆ $globalCommands

◆ $globalEntityCommands

◆ $help

◆ $httpState

◆ $idp

◆ $ignoredUserFields

◆ $lng

◆ $mapping

◆ $rbac

◆ $ref_id

◆ $refinery

◆ $samlAuth

◆ $tabs

◆ $toolbar

◆ $tpl

◆ DEFAULT_CMD

◆ VIEW_MODE_GLOBAL

◆ VIEW_MODE_SINGLE