Collaboration diagram for ilECSParticipantSettingsGUI:

Public Member Functions
	__construct (int $a_server_id, int $a_mid)

	getServerId ()

	getMid ()

	executeCommand ()
	Execute command. More...

Protected Member Functions
	renderConsentToolbar ()

	resetConsents ()

	saveSettings ()
	Save settings. More...

	initFormSettings ()
	Init settings form. More...

	parseAvailableAuthModes ()

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilTabsGUI	$tabs

UiFactory	$ui_factory

ilToolbarGUI	$toolbar

ilSetting	$settings

ilECSAuthFactory	$auth_factory

Private Member Functions
	getParticipant ()

	abort ()
	Abort editing. More...

	settings (?ilPropertyFormGUI $form=null)
	Settings. More...

	setTabs ()
	Set tabs. More...

Private Attributes
int	$server_id

int	$mid

ilECSParticipantSetting	$participant

Detailed Description

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

Definition at line 26 of file class.ilECSParticipantSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSParticipantSettingsGUI::__construct	(	int	$a_server_id,
		int	$a_mid
	)

Definition at line 42 of file class.ilECSParticipantSettingsGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->ui_factory = $DIC->ui()->factory();
        $this->toolbar = $DIC->toolbar();
        $this->settings = $DIC->settings();
 
        $this->server_id = $a_server_id;
        $this->mid = $a_mid;
 
        $this->lng->loadLanguageModule('ecs');
        $this->lng->loadLanguageModule('auth');
 
        $this->participant = new ilECSParticipantSetting($this->getServerId(), $this->getMid());
        $this->auth_factory = new ilECSAuthFactory();
    }

References $DIC, ILIAS\Repository\ctrl(), getMid(), getServerId(), ILIAS\Repository\lng(), settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ abort()

ilECSParticipantSettingsGUI::abort ( )

private

Abort editing.

Definition at line 100 of file class.ilECSParticipantSettingsGUI.php.

                            : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ executeCommand()

ilECSParticipantSettingsGUI::executeCommand ( )

Execute command.

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

                                    : bool
    {
        $this->ctrl->saveParameter($this, 'server_id');
        $this->ctrl->saveParameter($this, 'mid');
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd('settings');
 
        $this->setTabs();
        $this->$cmd();
 
        return true;
    }

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

Here is the call graph for this function:

◆ getMid()

ilECSParticipantSettingsGUI::getMid ( )

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

                            : int
    {
        return $this->mid;
    }

References $mid.

Referenced by __construct(), renderConsentToolbar(), and resetConsents().

Here is the caller graph for this function:

◆ getParticipant()

ilECSParticipantSettingsGUI::getParticipant ( )

private

Definition at line 74 of file class.ilECSParticipantSettingsGUI.php.

                                     : ilECSParticipantSetting
    {
        return $this->participant;
    }

References $participant.

Referenced by initFormSettings(), and saveSettings().

Here is the caller graph for this function:

◆ getServerId()

ilECSParticipantSettingsGUI::getServerId ( )

Definition at line 64 of file class.ilECSParticipantSettingsGUI.php.

                                 : int
    {
        return $this->server_id;
    }

References $server_id.

Referenced by __construct(), renderConsentToolbar(), and resetConsents().

Here is the caller graph for this function:

◆ initFormSettings()

ilECSParticipantSettingsGUI::initFormSettings ( )

protected

Init settings form.

Definition at line 198 of file class.ilECSParticipantSettingsGUI.php.

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('ecs_part_settings') . ' ' . $this->getParticipant()->getTitle());
 
 
        $token = new ilCheckboxInputGUI($this->lng->txt('ecs_token_mechanism'), 'token');
        $token->setInfo($this->lng->txt('ecs_token_mechanism_info'));
        $token->setValue("1");
        $token->setChecked($this->getParticipant()->isTokenEnabled());
        $form->addItem($token);
 
        // Export
        $export = new ilCheckboxInputGUI($this->lng->txt('ecs_tbl_export'), 'export');
        $export->setValue("1");
        $export->setChecked($this->getParticipant()->isExportEnabled());
        $form->addItem($export);
 
        $auth_types = new ilCheckboxInputGUI(
            $this->lng->txt('ecs_export_local_account'),
            'incoming_local_accounts'
        );
        $auth_types->setInfo($this->lng->txt('ecs_export_local_account_info'));
        $auth_types->setChecked($this->getParticipant()->areIncomingLocalAccountsSupported());
        $export->addSubItem($auth_types);
 
        // radio group with login page and (optional) shibboleth option
        $external_auth_type = new ilRadioGroupInputGUI(
            $this->lng->txt('ecs_export_auth_type'),
            'incoming_auth_type'
        );
        $external_auth_type->setInfo($this->lng->txt('ecs_export_auth_type_info'));
        $external_auth_type->setValue(
            (string) $this->getParticipant()->getIncomingAuthType()
        );
        foreach ($this->auth_factory->getAvailableStrategies() as $auth_type => $auth_strategy) {
            $external_auth_type->addOption(
                new ilRadioOption(
                    $this->lng->txt("ecs_export_auth_type_{$auth_strategy->getName()}"),
                    (string) $auth_type
                )
            );
        }
        $external_auth_type->addOption(
            new ilRadioOption(
                $this->lng->txt('ecs_export_auth_type_none'),
                (string) ilECSParticipantSetting::INCOMING_AUTH_TYPE_INACTIVE
            )
        );
        $export->addSubItem($external_auth_type);
 
        // Export types
        $obj_types = new ilCheckboxGroupInputGUI($this->lng->txt('ecs_export_types'), 'export_types');
        $obj_types->setValue($this->getParticipant()->getExportTypes());
 
 
        foreach (ilECSUtils::getPossibleReleaseTypes(true) as $type => $trans) {
            $obj_types->addOption(new ilCheckboxOption($trans, $type));
        }
        $export->addSubItem($obj_types);
 
 
        // Import
        $import = new ilCheckboxInputGUI($this->lng->txt('ecs_tbl_import'), 'import');
        $import->setValue("1");
        $import->setChecked($this->getParticipant()->isImportEnabled());
        $form->addItem($import);
 
        // user credentials by auth mode
        $user_credentials = new ilCheckboxGroupInputGUI(
            $this->lng->txt('ecs_import_user_credentials_by_auth_mode'),
            'outgoing_auth_modes'
        );
        $user_credentials->setInfo($this->lng->txt('ecs_import_user_credentials_by_auth_mode_info'));
        $user_credentials->setValue($this->getParticipant()->getOutgoingAuthModes());
        $import->addSubItem($user_credentials);
        foreach ($this->parseAvailableAuthModes() as $option_name => $option_text) {
            // default login does not need a placeholder
            if ($option_name === 'ilias') {
                continue;
            }
 
            $option = new ilCheckboxOption(
                sprintf($this->lng->txt('ecs_import_auth_mode'), $option_text),
                $option_name
            );
            $user_credentials->addOption($option);
            $username_placeholder = new ilTextInputGUI(
                $this->lng->txt('ecs_outgoing_user_credentials'),
                'username_placeholder_' . $option_name
            );
            $username_placeholder->setRequired(false);
            $username_placeholder->setInfo($this->lng->txt('ecs_outgoing_user_credentials_info'));
            $username_placeholder->setValue(
                $this->getParticipant()->getOutgoingUsernamePlaceholderByAuthMode(
                    $option_name
                )
            );
            $option->addSubItem($username_placeholder);
        }
        $option = new ilCheckboxOption(
            $this->lng->txt('ecs_import_auth_type_default'),
            'default'
        );
        $user_credentials->addOption($option);
 
        // Import types
        $imp_types = new ilCheckboxGroupInputGUI($this->lng->txt('ecs_import_types'), 'import_types');
        $imp_types->setValue($this->getParticipant()->getImportTypes());
 
 
        foreach (ilECSUtils::getPossibleRemoteTypes(true) as $type => $trans) {
            $imp_types->addOption(new ilCheckboxOption($trans, $type));
        }
        $import->addSubItem($imp_types);
 
        $form->addCommandButton('saveSettings', $this->lng->txt('save'));
        $form->addCommandButton('abort', $this->lng->txt('cancel'));
        return $form;
    }

References $token, ILIAS\Repository\ctrl(), getParticipant(), ilECSUtils\getPossibleReleaseTypes(), ilECSUtils\getPossibleRemoteTypes(), ilECSParticipantSetting\INCOMING_AUTH_TYPE_INACTIVE, ILIAS\Repository\lng(), and parseAvailableAuthModes().

Referenced by saveSettings(), and settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseAvailableAuthModes()

ilECSParticipantSettingsGUI::parseAvailableAuthModes ( )

protected

Definition at line 320 of file class.ilECSParticipantSettingsGUI.php.

                                                : array
    {
        $options = [];
        foreach ($this->auth_factory->getAvailableStrategies() as $auth_strategy) {
            $options[$auth_strategy->getName()] = $this->lng->txt("auth_{$auth_strategy->getName()}");
        }
 
        foreach (ilLDAPServer::getServerIds() as $server_id) {
            $server = ilLDAPServer::getInstanceByServerId($server_id);
            $options['ldap_' . $server->getServerId()] = $server->getName();
        }
        return $options;
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, $server, $server_id, ilLDAPServer\getInstanceByServerId(), ilLDAPServer\getServerIds(), and ILIAS\Repository\lng().

Referenced by initFormSettings(), and saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderConsentToolbar()

ilECSParticipantSettingsGUI::renderConsentToolbar ( )

protected

Definition at line 119 of file class.ilECSParticipantSettingsGUI.php.

                                             : void
    {
        $consents = new ilECSParticipantConsents(
            $this->getServerId(),
            $this->getMid()
        );
        if (!$consents->hasConsents()) {
            return;
        }
 
        $confirm = $this->ui_factory->modal()->interruptive(
            $this->lng->txt('ecs_consent_reset_confirm_title'),
            $this->lng->txt('ecs_consent_reset_confirm_title_info'),
            $this->ctrl->getLinkTarget($this, 'resetConsents')
        );
        $this->toolbar->addComponent($confirm);
 
        $confirmation_trigger = $this->ui_factory->button()->standard(
            $this->lng->txt('ecs_consent_reset_confirm_title'),
            ''
        )->withOnClick($confirm->getShowSignal());
        $this->toolbar->addComponent($confirmation_trigger);
    }

References getMid(), getServerId(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetConsents()

ilECSParticipantSettingsGUI::resetConsents ( )

protected

Definition at line 143 of file class.ilECSParticipantSettingsGUI.php.

    {
        $consents = new ilECSParticipantConsents($this->getServerId(), $this->getMid());
        $consents->delete();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('ecs_user_consents_deleted'), true);
        $this->ctrl->redirect($this, 'settings');
    }

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

Here is the call graph for this function:

◆ saveSettings()

ilECSParticipantSettingsGUI::saveSettings ( )

protected

Save settings.

Definition at line 154 of file class.ilECSParticipantSettingsGUI.php.

                                     : void
    {
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $this->getParticipant()->enableToken((bool) $form->getInput('token'));
            $this->getParticipant()->enableExport((bool) $form->getInput('export'));
            $this->getParticipant()->setExportTypes($form->getInput('export_types'));
            $this->getParticipant()->enableImport((bool) $form->getInput('import'));
            $this->getParticipant()->setImportTypes($form->getInput('import_types'));
            $this->getParticipant()->enableIncomingLocalAccounts((bool) $form->getInput('incoming_local_accounts'));
            $this->getParticipant()->setIncomingAuthType((int) $form->getInput('incoming_auth_type'));
            $this->getParticipant()->setOutgoingAuthModes((array) $form->getInput('outgoing_auth_modes'));
 
            // placeholders
            $placeholders = [];
            foreach ($this->parseAvailableAuthModes() as $authmode_name => $authmode_text) {
                $placeholders[$authmode_name] = $form->getInput(
                    'username_placeholder_' . $authmode_name
                );
            }
            $this->getParticipant()->setOutgoingUsernamePlaceholders($placeholders);
 
            // additional validation
            $error_code = $this->getParticipant()->validate();
            switch ($error_code) {
                case ilECSParticipantSetting::ERR_MISSING_USERNAME_PLACEHOLDER:
                    $form->getItemByPostVar('outgoing_auth_modes')->setAlert(
                        $this->lng->txt('ecs_username_place_holder_err_mssing_placeholder')
                    );
                    break;
                default:
                    $this->getParticipant()->update();
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
                    $this->ctrl->redirect($this, 'settings');
            }
        }
        $form->setValuesByPost();
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
        $this->settings($form);
    }

References ILIAS\Repository\ctrl(), ilECSParticipantSetting\ERR_MISSING_USERNAME_PLACEHOLDER, getParticipant(), initFormSettings(), ILIAS\Repository\lng(), parseAvailableAuthModes(), and settings().

Here is the call graph for this function:

◆ setTabs()

ilECSParticipantSettingsGUI::setTabs ( )

private

Set tabs.

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

                              : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getParentReturnByClass(self::class)
        );
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

ilECSParticipantSettingsGUI::settings ( ?ilPropertyFormGUI $form = null )

private

Settings.

Definition at line 109 of file class.ilECSParticipantSettingsGUI.php.

                                                              : void
    {
        $this->renderConsentToolbar();
 
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initFormSettings();
        }
        $this->tpl->setContent($form->getHTML());
    }