ilCASSettingsGUI Class Reference

Collaboration diagram for ilCASSettingsGUI:

Public Member Functions
	__construct (int $a_auth_ref_id)
	executeCommand ()
	settings ()
	save ()

Data Fields
const	SYNC_DISABLED = 0
const	SYNC_CAS = 1
const	SYNC_LDAP = 2

Protected Member Functions
	getSettings ()
	initFormSettings ()

Private Member Functions
	prepareRoleSelection ()

Private Attributes
ilCASSettings	$settings
int	$ref_id
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl
ilLanguage	$lng
ilRbacSystem	$rbacSystem
ilRbacReview	$rbacReview
ilErrorHandling	$ilErr

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilCASSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilCASSettingsGUI::__construct

(

int

$a_auth_ref_id

)

Definition at line 41 of file class.ilCASSettingsGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ilCASSettings\getInstance(), ILIAS\Repository\lng(), and settings().

    {
        global $DIC;
        $this->tpl = $DIC->ui()->mainTemplate();

        $this->ctrl = $DIC->ctrl();
        $this->rbacSystem = $DIC->rbac()->system();
        $this->rbacReview = $DIC->rbac()->review();
        $this->ilErr = $DIC['ilErr'];
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('registration');
        $this->lng->loadLanguageModule('auth');

        $this->renderer = $DIC->ui()->renderer();
        $this->factory = $DIC->ui()->factory();

        $this->ref_id = $a_auth_ref_id;

        $this->settings = ilCASSettings::getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilCASSettingsGUI::executeCommand

(

)

Definition at line 67 of file class.ilCASSettingsGUI.php.

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

                                    : bool
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("settings");

        if (!$this->rbacSystem->checkAccess("visible,read", $this->ref_id)) {
            $this->ilErr->raiseError($this->lng->txt('msg_no_perm_read'), $this->ilErr->WARNING);
        }

        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = "settings";
                }
                $this->$cmd();
                break;
        }
        return true;
    }

Here is the call graph for this function:

getSettings()

ilCASSettingsGUI::getSettings ( )

protected

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

References $settings.

Referenced by initFormSettings(), and save().

                                    : ilCASSettings
    {
        return $this->settings;
    }

Here is the caller graph for this function:

initFormSettings()

ilCASSettingsGUI::initFormSettings ( )

protected

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

References $check, ilAuthUtils\AUTH_CAS, ILIAS\Repository\ctrl(), ilLDAPServer\getAvailableDataSources(), ilLDAPServer\getDataSource(), getSettings(), ilLDAPServer\isDataSourceActive(), ILIAS\Repository\lng(), prepareRoleSelection(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setValue(), ilCASSettings\SYNC_CAS, ilCASSettings\SYNC_DISABLED, and ilCASSettings\SYNC_LDAP.

Referenced by save(), and settings().

                                         : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule('auth');

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));

        $form->setTitle($this->lng->txt('auth_cas_auth'));

        $drop_in_replacements_url = 'https://github.com/ILIAS-eLearning/ILIAS/tree/trunk/components/ILIAS/HTTP#dropinreplacements';
        $drop_in_replacements_link = $this->factory->link()->standard(
            $this->lng->txt("auth_cas_auth_desc"),
            $drop_in_replacements_url
        );
        $form->setDescription($this->renderer->render(
            $drop_in_replacements_link
        ));

        // Form checkbox
        $check = new ilCheckboxInputGUI($this->lng->txt("active"), 'active');
        $check->setChecked($this->getSettings()->isActive());
        $check->setValue("1");
        $form->addItem($check);

        $text = new ilTextInputGUI($this->lng->txt('server'), 'server');
        $text->setValue($this->getSettings()->getServer());
        $text->setRequired(true);
        $text->setInfo($this->lng->txt('auth_cas_server_desc'));
        $text->setSize(64);
        $text->setMaxLength(255);
        $form->addItem($text);

        $port = new ilNumberInputGUI($this->lng->txt("port"), 'port');
        $port->setValue((string) $this->getSettings()->getPort());
        $port->setRequired(true);
        $port->setMinValue(0);
        $port->setMaxValue(65535);
        $port->setSize(5);
        $port->setMaxLength(5);
        $port->setInfo($this->lng->txt('auth_cas_port_desc'));
        $form->addItem($port);

        $text = new ilTextInputGUI($this->lng->txt('uri'), 'uri');
        $text->setValue($this->getSettings()->getUri());
        $text->setRequired(true);
        $text->setInfo($this->lng->txt('auth_cas_uri_desc'));
        $text->setSize(64);
        $text->setMaxLength(255);
        $form->addItem($text);

        // User synchronization
        // 0: Disabled
        // 1: CAS
        // 2: LDAP
        $sync = new ilRadioGroupInputGUI($this->lng->txt('auth_sync'), 'sync');
        $sync->setRequired(true);
        $form->addItem($sync);

        // Disabled
        $dis = new ilRadioOption(
            $this->lng->txt('disabled'),
            (string) self::SYNC_DISABLED,
            ''
        );
        $sync->addOption($dis);

        // CAS
        $rad = new ilRadioOption(
            $this->lng->txt('auth_sync_cas'),
            (string) self::SYNC_CAS,
            ''
        );
        $rad->setInfo($this->lng->txt('auth_sync_cas_info'));
        $sync->addOption($rad);

        $select = new ilSelectInputGUI($this->lng->txt('auth_user_default_role'), 'role');
        $select->setOptions($this->prepareRoleSelection());
        $select->setValue($this->getSettings()->getDefaultRole());
        $rad->addSubItem($select);


        // LDAP
        $server_ids = ilLDAPServer::getAvailableDataSources(ilAuthUtils::AUTH_CAS);

        if (count($server_ids)) {
            $ldap = new ilRadioOption(
                $this->lng->txt('auth_css_ldap'),
                (string) ilCASSettings::SYNC_LDAP,
                ''
            );
            $ldap->setInfo($this->lng->txt('auth_cas_ldap_info'));
            $sync->addOption($ldap);

            $ldap_server_select = new ilSelectInputGUI($this->lng->txt('auth_ldap_server_ds'), 'ldap_sid');
            $options[0] = $this->lng->txt('select_one');
            foreach ($server_ids as $ldap_sid) {
                $ldap_server = new ilLDAPServer($ldap_sid);
                $options[$ldap_sid] = $ldap_server->getName();
            }
            $ldap_server_select->setOptions($options);
            $ldap_server_select->setRequired(true);
            $ds = ilLDAPServer::getDataSource(ilAuthUtils::AUTH_CAS);
            $ldap_server_select->setValue($ds);

            $ldap->addSubItem($ldap_server_select);
        }

        if (ilLDAPServer::isDataSourceActive(ilAuthUtils::AUTH_CAS)) {
            $sync->setValue((string) ilCASSettings::SYNC_LDAP);
        } else {
            $sync->setValue(
                $this->getSettings()->isUserCreationEnabled() ?
                    (string) ilCASSettings::SYNC_CAS :
                    (string) ilCASSettings::SYNC_DISABLED
            );
        }

        $instruction = new ilTextAreaInputGUI($this->lng->txt('auth_login_instructions'), 'instruction');
        $instruction->setCols(80);
        $instruction->setRows(6);
        $instruction->setValue($this->getSettings()->getLoginInstruction());
        $form->addItem($instruction);

        $create = new ilCheckboxInputGUI($this->lng->txt('auth_allow_local'), 'local');
        $create->setInfo($this->lng->txt('auth_cas_allow_local_desc'));
        $create->setChecked($this->getSettings()->isLocalAuthenticationEnabled());
        $create->setValue("1");
        $form->addItem($create);

        if ($this->rbacSystem->checkAccess('write', $this->ref_id)) {
            $form->addCommandButton('save', $this->lng->txt('save'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareRoleSelection()

ilCASSettingsGUI::prepareRoleSelection ( )

private

Definition at line 270 of file class.ilCASSettingsGUI.php.

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

Referenced by initFormSettings().

                                           : array
    {
        $global_roles = ilUtil::_sortIds(
            $this->rbacReview->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((int) $role_id);
        }

        return $select;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilCASSettingsGUI::save

(

)

Definition at line 229 of file class.ilCASSettingsGUI.php.

References ilAuthUtils\AUTH_CAS, ILIAS\Repository\ctrl(), ilLDAPServer\disableDataSourceForAuthMode(), getSettings(), initFormSettings(), ILIAS\Repository\lng(), settings(), ilCASSettings\SYNC_CAS, ilCASSettings\SYNC_DISABLED, ilCASSettings\SYNC_LDAP, and ilLDAPServer\toggleDataSource().

                          : void
    {
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $this->getSettings()->setActive((bool) $form->getInput('active'));
            $this->getSettings()->setServer($form->getInput('server'));
            $this->getSettings()->setPort((int) $form->getInput('port'));
            $this->getSettings()->setUri($form->getInput('uri'));
            $this->getSettings()->setDefaultRole((int) $form->getInput('role'));
            $this->getSettings()->enableLocalAuthentication((bool) $form->getInput('local'));
            $this->getSettings()->setLoginInstruction($form->getInput('instruction'));
            $this->getSettings()->enableUserCreation((int) $form->getInput('sync') === ilCASSettings::SYNC_CAS);
            $this->getSettings()->save();

            switch ((int) $form->getInput('sync')) {
                case ilCASSettings::SYNC_CAS:
                case ilCASSettings::SYNC_DISABLED:
                    ilLDAPServer::disableDataSourceForAuthMode(ilAuthUtils::AUTH_CAS);
                    break;

                case ilCASSettings::SYNC_LDAP:
                    if (!(int) $form->getInput('ldap_sid')) {
                        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
                        $this->settings();
                        //TODO do we need return false?
                        return;
                    }

                    ilLDAPServer::toggleDataSource((int) $form->getInput('ldap_sid'), ilAuthUtils::AUTH_CAS, 1);
                    break;
            }

            $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_ceck_input'));
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

settings()

ilCASSettingsGUI::settings

(

)

Definition at line 223 of file class.ilCASSettingsGUI.php.

References initFormSettings().

Referenced by __construct(), and save().

                              : void
    {
        $form = $this->initFormSettings();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilCASSettingsGUI::$ctrl

private

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

$ilErr

ilErrorHandling ilCASSettingsGUI::$ilErr

private

Definition at line 39 of file class.ilCASSettingsGUI.php.

$lng

ilLanguage ilCASSettingsGUI::$lng

private

Definition at line 36 of file class.ilCASSettingsGUI.php.

$rbacReview

ilRbacReview ilCASSettingsGUI::$rbacReview

private

Definition at line 38 of file class.ilCASSettingsGUI.php.

$rbacSystem

ilRbacSystem ilCASSettingsGUI::$rbacSystem

private

Definition at line 37 of file class.ilCASSettingsGUI.php.

$ref_id

int ilCASSettingsGUI::$ref_id

private

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

$settings

ilCASSettings ilCASSettingsGUI::$settings

private

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

Referenced by getSettings().

$tpl

ilGlobalTemplateInterface ilCASSettingsGUI::$tpl

private

Definition at line 34 of file class.ilCASSettingsGUI.php.

SYNC_CAS

const ilCASSettingsGUI::SYNC_CAS = 1

Definition at line 27 of file class.ilCASSettingsGUI.php.

SYNC_DISABLED

const ilCASSettingsGUI::SYNC_DISABLED = 0

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

SYNC_LDAP

const ilCASSettingsGUI::SYNC_LDAP = 2

Definition at line 28 of file class.ilCASSettingsGUI.php.

---

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

• Services/CAS/classes/class.ilCASSettingsGUI.php