Login page editor settings GUI ILIAS page editor or richtext editor. More...

Collaboration diagram for ilAuthLoginPageEditorGUI:

Public Member Functions
	__construct (int $a_ref_id)

	getSettings ()

	getRefId ()

	executeCommand ()
	ilCtrl execute command More...

Protected Member Functions
	forwardToPageObject ()
	Forward to page editor. More...

	show ()
	Show current activated editor. More...

	addEditorSwitch ()
	Show editor switch. More...

	switchIPE ()
	Switch editor mode to ILIAS Page editor. More...

	switchRTE ()
	Switch editor mode to richtext editor. More...

	activate ()
	Activate languages. More...

	showIliasEditor ()
	Show ILIAS page editor summary. More...

	showRichtextEditor ()
	Show richtext editor @global ilRbacSystem $rbacsystem @global ilLanguage $lng @global ilSetting $ilSetting. More...

	saveLoginInfo ()
	saves the login information data More...

	initLoginForm ()
	Init login form. More...

Protected Attributes
ILIAS Style Content Object ObjectFacade	$content_style_domain

Private Member Functions
	setDefLangFirst (string $a_def_language, array $a_languages)
	returns an array of all installed languages, default language at the first position More...

Private Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

ilRbacSystem	$rbacsystem

ilSetting	$setting

ilErrorHandling	$ilErr

ilPropertyFormGUI	$form

int	$ref_id

ilAuthLoginPageEditorSettings	$settings

ilSetting	$loginSettings = null

string	$redirect_source = null

int	$key = null

array	$visible_languages = []

array	$languages = []

Detailed Description

Login page editor settings GUI ILIAS page editor or richtext editor.

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

@ilCtrl_isCalledBy ilAuthLoginPageEditorGUI: ilObjAuthSettingsGUI @ilCtrl_Calls ilAuthLoginPageEditorGUI: ilLoginPageGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilAuthLoginPageEditorGUI::__construct ( int $a_ref_id )

Definition at line 53 of file class.ilAuthLoginPageEditorGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->setting = $DIC->settings();
        $this->ilErr = $DIC['ilErr'];
 
        $this->lng = $DIC['lng'];
 
        $this->lng->loadLanguageModule('auth');
        $this->ref_id = $a_ref_id;
 
        $this->settings = ilAuthLoginPageEditorSettings::getInstance();
        $this->content_style_domain = $DIC->contentStyle()
                                          ->domain()
                                          ->styleForRefId($a_ref_id);
 
        $query_wrapper = $DIC->http()->wrapper()->query();
        $post_wrapper = $DIC->http()->wrapper()->post();
        $is_post_request = $DIC->http()->request()->getMethod() === "POST";
        $refinery = $DIC->refinery();
 
        if ($query_wrapper->has("redirectSource")) {
            $this->redirect_source = $query_wrapper->retrieve("redirectSource", $refinery->kindlyTo()->string());
        }
        if ($post_wrapper->has("key")) {
            $this->key = $post_wrapper->retrieve("key", $refinery->kindlyTo()->int());
        } elseif ($query_wrapper->has("key")) {
            $this->key = $query_wrapper->retrieve("key", $refinery->kindlyTo()->int());
        }
        if ($is_post_request) {
            if ($post_wrapper->has("visible_languages")) {
                $this->visible_languages = $post_wrapper->retrieve("visible_languages", $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string()));
            }
            if ($post_wrapper->has("languages")) {
                $this->languages = $post_wrapper->retrieve("languages", $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string()));
            }
        }
    }

References $DIC, ILIAS\Repository\$refinery, ILIAS\Repository\ctrl(), ilAuthLoginPageEditorSettings\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilAuthLoginPageEditorGUI::activate ( )

protected

Activate languages.

Definition at line 255 of file class.ilAuthLoginPageEditorGUI.php.

                                 : void
    {
        $settings = ilAuthLoginPageEditorSettings::getInstance();
        foreach ($this->visible_languages as $lang_key) {
            $settings->enableIliasEditor($lang_key, in_array($lang_key, $this->languages, true));
        }
        $settings->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

References $settings, ILIAS\Repository\ctrl(), ilAuthLoginPageEditorSettings\enableIliasEditor(), ilAuthLoginPageEditorSettings\getInstance(), ILIAS\Repository\lng(), and ilAuthLoginPageEditorSettings\update().

Here is the call graph for this function:

◆ addEditorSwitch()

ilAuthLoginPageEditorGUI::addEditorSwitch ( )

protected

Show editor switch.

Definition at line 206 of file class.ilAuthLoginPageEditorGUI.php.

                                        : void
    {
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
        switch ($this->getSettings()->getMode()) {
            case ilAuthLoginPageEditorSettings::MODE_RTE:
 
                $this->toolbar->addButton(
                    $this->lng->txt('login_page_switch_ipe'),
                    $this->ctrl->getLinkTarget($this, 'switchIPE')
                );
                break;
 
            case ilAuthLoginPageEditorSettings::MODE_IPE:
 
                $this->toolbar->addButton(
                    $this->lng->txt('login_page_switch_rte'),
                    $this->ctrl->getLinkTarget($this, 'switchRTE')
                );
                break;
        }
    }

References ILIAS\Repository\ctrl(), getSettings(), ILIAS\Repository\lng(), ilAuthLoginPageEditorSettings\MODE_IPE, ilAuthLoginPageEditorSettings\MODE_RTE, and ILIAS\Repository\toolbar().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilAuthLoginPageEditorGUI::executeCommand ( )

ilCtrl execute command

Definition at line 111 of file class.ilAuthLoginPageEditorGUI.php.

                                    : void
    {
        switch ($this->ctrl->getNextClass($this)) {
            case 'illoginpagegui':
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, 'show'),
                    '_top'
                );
 
                if ($this->redirect_source !== "ilinternallinkgui") {
                    $this->forwardToPageObject();
                }
                break;
 
            default:
                if (!$cmd = $this->ctrl->getCmd()) {
                    $cmd = 'show';
                }
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

◆ forwardToPageObject()

ilAuthLoginPageEditorGUI::forwardToPageObject ( )

protected

Forward to page editor.

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

                                            : void
    {
        $this->ctrl->saveParameter($this, 'key');
 
        $this->lng->loadLanguageModule("content");
 
        if (!ilLoginPage::_exists('auth', $this->key)) {
            // doesn't exist -> create new one
            $new_page_object = new ilLoginPage();
            $new_page_object->setParentId($this->key);
            $new_page_object->setId($this->key);
            $new_page_object->createFromXML();
        }
 
        $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
 
 
        $this->ctrl->setReturnByClass('illoginpagegui', "edit");
        $page_gui = new ilLoginPageGUI($this->key);
 
        $page_gui->setTemplateTargetVar("ADM_CONTENT");
        //TODO check what should go here $link_xml is undefined
        //$page_gui->setLinkXML($link_xml);
        //$page_gui->enableChangeComments($this->content_object->isActiveHistoryUserComments());
        //$page_gui->setFileDownloadLink($this->ctrl->getLinkTarget($this, "downloadFile"));
        //$page_gui->setFullscreenLink($this->ctrl->getLinkTarget($this, "showMediaFullscreen"));
        //$page_gui->setLinkParams($this->ctrl->getUrlParameterString()); // todo
        //              $page_gui->setSourcecodeDownloadScript($this->ctrl->getLinkTarget($this, ""));
        $page_gui->setStyleId($this->content_style_domain->getEffectiveStyleId());
        $page_gui->setTemplateOutput(false);
        //$page_gui->setLocator($contObjLocator);
 
        // style tab
        //$page_gui->setTabHook($this, "addPageTabs");
 
        if ($this->ctrl->getCmd() === 'editPage') {
            $this->ctrl->setCmd('edit');
        }
        $html = $this->ctrl->forwardCommand($page_gui);
 
        if ($html !== "") {
            $this->tpl->setContent($html);
        }
    }

References ilPageObject\_exists(), ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilAuthLoginPageEditorGUI::getRefId ( )

Definition at line 103 of file class.ilAuthLoginPageEditorGUI.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

◆ getSettings()

ilAuthLoginPageEditorGUI::getSettings ( )

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

                                 : ilAuthLoginPageEditorSettings
    {
        return $this->settings;
    }

References $settings.

Referenced by addEditorSwitch(), show(), switchIPE(), and switchRTE().

Here is the caller graph for this function:

◆ initLoginForm()

ilAuthLoginPageEditorGUI::initLoginForm ( )

protected

Init login form.

Definition at line 340 of file class.ilAuthLoginPageEditorGUI.php.

                                      : void
    {
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'saveLoginInfo'));
        $this->form->setTableWidth('80%');
        $this->form->setTitle($this->lng->txt('login_information'));
 
        $this->form->addCommandButton('saveLoginInfo', $this->lng->txt('save'));
 
        if ($ldap_id = ilLDAPServer::_getFirstActiveServer()) {
            $select = new ilSelectInputGUI($this->lng->txt('default_auth_mode'), 'default_auth_mode');
            $select->setValue($this->setting->get('default_auth_mode', (string) ilAuthUtils::AUTH_LOCAL));
            $select->setInfo($this->lng->txt('default_auth_mode_info'));
            $options[ilAuthUtils::AUTH_LOCAL] = $this->lng->txt('auth_local');
            if ($ldap_id) {
                $options[ilAuthUtils::AUTH_LDAP] = $this->lng->txt('auth_ldap');
            }
            $select->setOptions($options);
            $this->form->addItem($select);
        }
 
        if (!is_object($this->loginSettings)) {
            $this->loginSettings = new ilSetting("login_settings");
        }
 
        $login_settings = $this->loginSettings->getAll();
        $languages = $this->lng->getInstalledLanguages();
        $def_language = $this->lng->getDefaultLanguage();
 
        foreach ($this->setDefLangFirst($def_language, $languages) as $lang_key) {
            $add = "";
            if ($lang_key === $def_language) {
                $add = " (" . $this->lng->txt("default") . ")";
            }
 
            $textarea = new ilTextAreaInputGUI(
                $this->lng->txt("meta_l_" . $lang_key) . $add,
                'login_message_' . $lang_key
            );
            $textarea->setRows(10);
            $msg_login_lang = "login_message_" . $lang_key;
            if (isset($login_settings[$msg_login_lang])) {
                $textarea->setValue($login_settings[$msg_login_lang]);
            }
            $textarea->setUseRte(true);
            $textarea->setRteTagSet("extended");
            $this->form->addItem($textarea);
 
            unset($login_settings["login_message_" . $lang_key]);
        }
 
        foreach ($login_settings as $key => $message) {
            $lang_key = substr($key, strrpos($key, "_") + 1, strlen($key) - strrpos($key, "_"));
 
            $textarea = new ilTextAreaInputGUI(
                $this->lng->txt("meta_l_" . $lang_key),
                'login_message_' . $lang_key
            );
            $textarea->setRows(10);
            $textarea->setValue($message);
            $textarea->setUseRte(true);
            $textarea->setRteTagSet("extended");
            if (!in_array($lang_key, $languages, true)) {
                $textarea->setAlert($this->lng->txt("not_installed"));
            }
            $this->form->addItem($textarea);
        }
    }

References $key, $languages, $message, ilLDAPServer\_getFirstActiveServer(), ilAuthUtils\AUTH_LDAP, ilAuthUtils\AUTH_LOCAL, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), and setDefLangFirst().

Referenced by saveLoginInfo(), and showRichtextEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveLoginInfo()

ilAuthLoginPageEditorGUI::saveLoginInfo ( )

protected

saves the login information data

Author: Michael Jansen

Definition at line 311 of file class.ilAuthLoginPageEditorGUI.php.

                                      : void
    {
        if (!$this->rbacsystem->checkAccess("write", $this->getRefId())) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }
 
        $this->initLoginForm();
        if ($this->form->checkInput()) {
            // @todo: Move settings ilAuthLoginPageSettings
            $this->loginSettings = new ilSetting("login_settings");
            foreach ($this->lng->getInstalledLanguages() as $lang_key) {
                $settingKey = "login_message_" . $lang_key;
                if ($this->form->getInput($settingKey)) {
                    $this->loginSettings->set($settingKey, $this->form->getInput($settingKey));
                }
            }
            if ($this->form->getInput('default_auth_mode')) {
                $this->setting->set('default_auth_mode', $this->form->getInput('default_auth_mode'));
            }
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("login_information_settings_saved"), true);
        }
 
        $this->ctrl->redirect($this, 'show');
    }

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

Here is the call graph for this function:

◆ setDefLangFirst()

ilAuthLoginPageEditorGUI::setDefLangFirst	(	string	$a_def_language,
		array	$a_languages
	)

private

returns an array of all installed languages, default language at the first position

Parameters

string	$a_def_language	Default language of the current installation
array	$a_languages	Array of all installed languages

Returns: array $languages Array of the installed languages, default language at first position or an empty array, if $a_a_def_language is empty

Author: Michael Jansen

Definition at line 417 of file class.ilAuthLoginPageEditorGUI.php.

                                                                                : array
    {
        $languages = [];
        if ($a_def_language !== "") {
            $languages[] = $a_def_language;
 
            foreach ($a_languages as $val) {
                if (!in_array($val, $languages, true)) {
                    $languages[] = $val;
                }
            }
        }
 
        return $languages;
    }

References $languages.

Referenced by initLoginForm().

Here is the caller graph for this function:

◆ show()

ilAuthLoginPageEditorGUI::show ( )

protected

Show current activated editor.

Definition at line 189 of file class.ilAuthLoginPageEditorGUI.php.

                             : void
    {
        $this->addEditorSwitch();
 
        switch ($this->getSettings()->getMode()) {
            case ilAuthLoginPageEditorSettings::MODE_RTE:
                $this->showRichtextEditor();
                break;
            case ilAuthLoginPageEditorSettings::MODE_IPE:
                $this->showIliasEditor();
                break;
        }
    }

References addEditorSwitch(), getSettings(), ilAuthLoginPageEditorSettings\MODE_IPE, ilAuthLoginPageEditorSettings\MODE_RTE, showIliasEditor(), and showRichtextEditor().

Here is the call graph for this function:

◆ showIliasEditor()

ilAuthLoginPageEditorGUI::showIliasEditor ( )

protected

Show ILIAS page editor summary.

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

                                        : void
    {
        $tbl = new ilAuthLoginPageEditorTableGUI($this, 'show');
        $tbl->parse();
 
        $this->tpl->setContent($tbl->getHTML());
    }

Referenced by show().

Here is the caller graph for this function:

◆ showRichtextEditor()

ilAuthLoginPageEditorGUI::showRichtextEditor ( )

protected

Show richtext editor @global ilRbacSystem $rbacsystem @global ilLanguage $lng @global ilSetting $ilSetting.

Author: Michael Jansen

Definition at line 285 of file class.ilAuthLoginPageEditorGUI.php.

                                           : void
    {
        if (!$this->rbacsystem->checkAccess("visible,read", $this->getRefId())) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }
        $this->lng->loadLanguageModule("meta");
 
        $this->tpl->addBlockFile(
            "ADM_CONTENT",
            "adm_content",
            "tpl.auth_login_messages.html",
            "Services/Authentication"
        );
        $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        $this->tpl->setVariable("TXT_HEADLINE", $this->lng->txt("login_information"));
        $this->tpl->setVariable("TXT_DESCRIPTION", $this->lng->txt("login_information_desc"));
        $this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
        $this->initLoginForm();
        $this->tpl->setVariable('LOGIN_INFO', $this->form->getHTML());
    }

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

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchIPE()

ilAuthLoginPageEditorGUI::switchIPE ( )

protected

Switch editor mode to ILIAS Page editor.

Definition at line 231 of file class.ilAuthLoginPageEditorGUI.php.

                                  : void
    {
        $this->getSettings()->setMode(ilAuthLoginPageEditorSettings::MODE_IPE);
        $this->getSettings()->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('login_page_editor_switched'), true);
        $this->ctrl->redirect($this, 'show');
    }

References ILIAS\Repository\ctrl(), getSettings(), ILIAS\Repository\lng(), and ilAuthLoginPageEditorSettings\MODE_IPE.

Here is the call graph for this function:

◆ switchRTE()

ilAuthLoginPageEditorGUI::switchRTE ( )

protected

Switch editor mode to richtext editor.

Definition at line 243 of file class.ilAuthLoginPageEditorGUI.php.

                                  : void
    {
        $this->getSettings()->setMode(ilAuthLoginPageEditorSettings::MODE_RTE);
        $this->getSettings()->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('login_page_editor_switched'), true);
        $this->ctrl->redirect($this, 'show');
    }