ilAuthLoginPageEditorGUI Class Reference

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

Collaboration diagram for ilAuthLoginPageEditorGUI:

Public Member Functions
	__construct ($a_ref_id)
	Constructor. More...
	getSettings ()
	Get Settings. More...
	getRefId ()
	executeCommand ()
	ilCtrl execute command More...

Protected Member Functions
	forwardToPageObject ()
	Forward to page editor. More...
	show ()
	Show current activated editor. More...
	addEditorSwitch ()
	Show editore switch ilToolbarGUI $ilToolbar. More...
	switchIPE ()
	Switch editor mode. More...
	switchRTE ()
	Switch editor mode. More...
	activate ()
	Activate languages. More...
	showIliasEditor ()
	Show ILIAS page editor summary. More...
	showRichtextEditor ()
	Show richtext editor ilRbacSystem $rbacsystem ilLanguage $lng ilSetting $ilSetting. More...
	saveLoginInfo ()
	saves the login information data More...
	initLoginForm ()
	Init login form. More...
	setDefLangFirst ($a_def_language, $a_languages)
	returns an array of all installed languages, default language at the first position More...

Protected Attributes
	$ctrl = null
	$lng = null

Private Attributes
	$ref_id = 0
	$settings = null

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

ilAuthLoginPageEditorGUI: ilObjAuthSettingsGUI ilAuthLoginPageEditorGUI: ilLoginPageGUI

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

Constructor & Destructor Documentation

__construct()

ilAuthLoginPageEditorGUI::__construct

(

$a_ref_id

)

Constructor.

Parameters

int

$a_ref_id

ilCtrl ilCtrl

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

References $DIC, $ilCtrl, $lng, ilAuthLoginPageEditorSettings\getInstance(), and settings().

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->lng->loadLanguageModule('auth');
        $this->ref_id = $a_ref_id;

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

Here is the call graph for this function:

Member Function Documentation

activate()

ilAuthLoginPageEditorGUI::activate ( )

protected

Activate languages.

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

References $_POST, $settings, and ilAuthLoginPageEditorSettings\getInstance().

    {
        $settings = ilAuthLoginPageEditorSettings::getInstance();
        foreach ((array) $_POST['visible_languages'] as $lang_key) {
            $settings->enableIliasEditor($lang_key, in_array($lang_key, (array) $_POST['languages']));
        }
        $settings->update();

        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

addEditorSwitch()

ilAuthLoginPageEditorGUI::addEditorSwitch ( )

protected

Show editore switch ilToolbarGUI $ilToolbar.

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

References $DIC, getSettings(), ilAuthLoginPageEditorSettings\MODE_IPE, and ilAuthLoginPageEditorSettings\MODE_RTE.

Referenced by show().

    {
        global $DIC;

        $ilToolbar = $DIC['ilToolbar'];

        $ilToolbar->setFormAction($this->ctrl->getFormAction($this));
        switch ($this->getSettings()->getMode()) {
            case ilAuthLoginPageEditorSettings::MODE_RTE:

                $ilToolbar->addButton(
                    $this->lng->txt('login_page_switch_ipe'),
                    $this->ctrl->getLinkTarget($this, 'switchIPE')
                );
                break;

            case ilAuthLoginPageEditorSettings::MODE_IPE:

                $ilToolbar->addButton(
                    $this->lng->txt('login_page_switch_rte'),
                    $this->ctrl->getLinkTarget($this, 'switchRTE')
                );
                break;
        }
        return;
    }

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 68 of file class.ilAuthLoginPageEditorGUI.php.

References $_GET, $GLOBALS, and forwardToPageObject().

    {
        switch ($this->ctrl->getNextClass($this)) {
            case 'illoginpagegui':
                $GLOBALS['DIC']['ilTabs']->clearTargets();
                $GLOBALS['DIC']['ilTabs']->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, 'show'),
                    '_top'
                );

                if ($_GET["redirectSource"] != "ilinternallinkgui") {
                    $this->forwardToPageObject();
                } else {
                    return '';
                }
                break;

            default:
                if (!$cmd = $this->ctrl->getCmd()) {
                    $cmd = 'show';
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

forwardToPageObject()

ilAuthLoginPageEditorGUI::forwardToPageObject ( )

protected

Forward to page editor.

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

References $DIC, $html, $key, $lng, $tpl, ilPageObject\_exists(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getEffectiveContentStyleId(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by executeCommand().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];

        $key = (int) $_REQUEST['key'];
        $this->ctrl->saveParameter($this, 'key', $key);

        include_once("./Services/Authentication/classes/class.ilLoginPage.php");
        include_once("./Services/Authentication/classes/class.ilLoginPageGUI.php");
        include_once './Services/Style/Content/classes/class.ilObjStyleSheet.php';

        $lng->loadLanguageModule("content");

        if (!ilLoginPage::_exists('auth', $key)) {
            // doesn't exist -> create new one
            $new_page_object = new ilLoginPage();
            $new_page_object->setParentId($key);
            $new_page_object->setId($key);
            $new_page_object->createFromXML();
        }

        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $tpl->setCurrentBlock("SyntaxStyle");
        $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
        $tpl->parseCurrentBlock();


        $this->ctrl->setReturnByClass('illoginpagegui', "edit");
        $page_gui = new ilLoginPageGUI($key);

        $page_gui->setTemplateTargetVar("ADM_CONTENT");
        $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->setPresentationTitle("");
        $page_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(0));
        $page_gui->setTemplateOutput(false);
        //$page_gui->setLocator($contObjLocator);
        $page_gui->setHeader("");

        // style tab
        //$page_gui->setTabHook($this, "addPageTabs");

        if ($this->ctrl->getCmd() == 'editPage') {
            $this->ctrl->setCmd('edit');
        }
        $html = $this->ctrl->forwardCommand($page_gui);

        $tpl->setContent($html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilAuthLoginPageEditorGUI::getRefId

(

)

Returns

int ref_id

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

References $ref_id.

    {
        return $this->ref_id;
    }

getSettings()

ilAuthLoginPageEditorGUI::getSettings

(

)

Get Settings.

Returns

ilAuthLoginPageEditorSettings

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

References $settings.

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

    {
        return $this->settings;
    }

Here is the caller graph for this function:

initLoginForm()

ilAuthLoginPageEditorGUI::initLoginForm ( )

protected

Init login form.

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

References $DIC, $ilSetting, $key, $languages, $lng, $message, PHPMailer\PHPMailer\$options, ilLDAPServer\_getFirstActiveServer(), ilRadiusSettings\_getInstance(), AUTH_LDAP, AUTH_LOCAL, AUTH_RADIUS, setDefLangFirst(), ilTextAreaInputGUI\setRows(), and ilSelectInputGUI\setValue().

Referenced by saveLoginInfo(), and showRichtextEditor().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilSetting = $DIC['ilSetting'];

        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $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'));

        include_once('Services/LDAP/classes/class.ilLDAPServer.php');
        include_once('Services/Radius/classes/class.ilRadiusSettings.php');
        $rad_settings = ilRadiusSettings::_getInstance();
        if ($ldap_id = ilLDAPServer::_getFirstActiveServer() or $rad_settings->isActive()) {
            $select = new ilSelectInputGUI($this->lng->txt('default_auth_mode'), 'default_auth_mode');
            $select->setValue($ilSetting->get('default_auth_mode', AUTH_LOCAL));
            $select->setInfo($this->lng->txt('default_auth_mode_info'));
            $options[AUTH_LOCAL] = $this->lng->txt('auth_local');
            if ($ldap_id) {
                $options[AUTH_LDAP] = $this->lng->txt('auth_ldap');
            }
            if ($rad_settings->isActive()) {
                $options [AUTH_RADIUS] = $this->lng->txt('auth_radius');
            }
            $select->setOptions($options);
            $this->form->addItem($select);
        }

        if (!is_object($this->loginSettings)) {
            $this->loginSettings = new ilSetting("login_settings");
        }

        $login_settings = $this->loginSettings->getAll();
        $languages = $lng->getInstalledLanguages();
        $def_language = $lng->getDefaultLanguage();

        foreach ($this->setDefLangFirst($def_language, $languages) as $lang_key) {
            $add = "";
            if ($lang_key == $def_language) {
                $add = " (" . $lng->txt("default") . ")";
            }

            $textarea = new ilTextAreaInputGUI(
                $lng->txt("meta_l_" . $lang_key) . $add,
                'login_message_' . $lang_key
            );
            $textarea->setRows(10);
            $textarea->setValue($login_settings["login_message_" . $lang_key]);
            $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(
                $lng->txt("meta_l_" . $lang_key) . $add,
                'login_message_' . $lang_key
            );
            $textarea->setRows(10);
            $textarea->setValue($message);
            $textarea->setUseRte(true);
            $textarea->setRteTagSet("extended");
            if (!in_array($lang_key, $languages)) {
                $textarea->setAlert($lng->txt("not_installed"));
            }
            $this->form->addItem($textarea);
        }
    }

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

protected

Author

Michael Jansen

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

References $_POST, $DIC, $ilErr, $ilSetting, $key, $lng, and initLoginForm().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilSetting = $DIC['ilSetting'];

        if (!$rbacsystem->checkAccess("write", $this->getRefId())) {
            $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
        }

        $this->initLoginForm();
        if ($this->form->checkInput()) {
            if (is_array($_POST)) {
                // @todo: Move settings ilAuthLoginPageSettings
                $this->loginSettings = new ilSetting("login_settings");

                foreach ($_POST as $key => $val) {
                    if (substr($key, 0, 14) == "login_message_") {
                        $this->loginSettings->set($key, $val);
                    }
                }
            }

            if ($_POST['default_auth_mode']) {
                $ilSetting->set('default_auth_mode', (int) $_POST['default_auth_mode']);
            }

            ilUtil::sendSuccess($this->lng->txt("login_information_settings_saved"), true);
        }

        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

setDefLangFirst()

ilAuthLoginPageEditorGUI::setDefLangFirst (   $a_def_language,   $a_languages  )

protected

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 public

Author

Michael Jansen

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

References $languages.

Referenced by initLoginForm().

    {
        if (is_array($a_languages) && $a_def_language != "") {
            $languages = array();
            $languages[] = $a_def_language;

            foreach ($a_languages as $val) {
                if (!in_array($val, $languages)) {
                    $languages[] = $val;
                }
            }

            return $languages;
        } else {
            return array();
        }
    }

Here is the caller graph for this function:

show()

ilAuthLoginPageEditorGUI::show ( )

protected

Show current activated editor.

Returns

void

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

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

    {
        $this->addEditorSwitch();

        switch ($this->getSettings()->getMode()) {
            case ilAuthLoginPageEditorSettings::MODE_RTE:
                return $this->showRichtextEditor();

            case ilAuthLoginPageEditorSettings::MODE_IPE:
                return $this->showIliasEditor();
        }
    }

Here is the call graph for this function:

showIliasEditor()

ilAuthLoginPageEditorGUI::showIliasEditor ( )

protected

Show ILIAS page editor summary.

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

References $DIC, $tbl, and $tpl.

Referenced by show().

    {
        global $DIC;

        $tpl = $DIC['tpl'];

        include_once './Services/Authentication/classes/class.ilAuthLoginPageEditorTableGUI.php';
        $tbl = new ilAuthLoginPageEditorTableGUI($this, 'show');
        $tbl->parse();

        $tpl->setContent($tbl->getHTML());
    }

Here is the caller graph for this function:

showRichtextEditor()

ilAuthLoginPageEditorGUI::showRichtextEditor ( )

protected

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

Author

Michael Jansen

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

References $DIC, $ilErr, $ilSetting, $lng, $tpl, and initLoginForm().

Referenced by show().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilSetting = $DIC['ilSetting'];
        $tpl = $DIC['tpl'];

        if (!$rbacsystem->checkAccess("visible,read", $this->getRefId())) {
            $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
        }
        $lng->loadLanguageModule("meta");

        $tpl->addBlockFile(
            "ADM_CONTENT",
            "adm_content",
            "tpl.auth_login_messages.html",
            "Services/Authentication"
        );
        $tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        $tpl->setVariable("TXT_HEADLINE", $this->lng->txt("login_information"));
        $tpl->setVariable("TXT_DESCRIPTION", $this->lng->txt("login_information_desc"));
        $tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
        $this->initLoginForm();
        $tpl->setVariable('LOGIN_INFO', $this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

switchIPE()

ilAuthLoginPageEditorGUI::switchIPE ( )

protected

Switch editor mode.

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

References getSettings(), and ilAuthLoginPageEditorSettings\MODE_IPE.

    {
        $this->getSettings()->setMode(ilAuthLoginPageEditorSettings::MODE_IPE);
        $this->getSettings()->update();

        ilUtil::sendSuccess($this->lng->txt('login_page_editor_switched'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

switchRTE()

ilAuthLoginPageEditorGUI::switchRTE ( )

protected

Switch editor mode.

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

References getSettings(), and ilAuthLoginPageEditorSettings\MODE_RTE.

    {
        $this->getSettings()->setMode(ilAuthLoginPageEditorSettings::MODE_RTE);
        $this->getSettings()->update();

        ilUtil::sendSuccess($this->lng->txt('login_page_editor_switched'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilAuthLoginPageEditorGUI::$ctrl = null

protected

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

$lng

ilAuthLoginPageEditorGUI::$lng = null

protected

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

Referenced by __construct(), forwardToPageObject(), initLoginForm(), saveLoginInfo(), and showRichtextEditor().

$ref_id

ilAuthLoginPageEditorGUI::$ref_id = 0

private

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

Referenced by getRefId().

$settings

ilAuthLoginPageEditorGUI::$settings = null

private

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

Referenced by activate(), and getSettings().

---

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

• Services/Authentication/classes/class.ilAuthLoginPageEditorGUI.php