@ilCtrl_isCalledBy ilAuthPageEditorGUI: ilObjAuthSettingsGUI @ilCtrl_Calls ilAuthPageEditorGUI: ilLoginPageGUI, ilLogoutPageGUI More...

Inheritance diagram for ilAuthPageEditorGUI:

Collaboration diagram for ilAuthPageEditorGUI:

Public Member Functions
	__construct (int $a_ref_id)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	executeCommand ()

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
final const string	DEFAULT_COMMAND = 'showPageEditorLanguages'

final const string	LANGUAGE_TABLE_ACTIONS_COMMAND = 'handlePageActions'

final const string	CONTEXT_HTTP_PARAM = 'auth_ipe_context'

Private Member Functions
	getRequestedAuthPageEditorContext ()

	forwardToPageObject ()

	handlePageActionsCommand ()

	getLangKeysToUpdate ()

	activate ()

	deactivate ()

	showPageEditorLanguagesCommand ()

Private Attributes
ilCtrlInterface	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ILIAS Style Content Object ObjectFacade	$content_style_domain

string	$redirect_source = null

int	$requested_language_id = null

GUIService	$content_style_gui

int	$ref_id

string	$request_ipe_context

Detailed Description

@ilCtrl_isCalledBy ilAuthPageEditorGUI: ilObjAuthSettingsGUI @ilCtrl_Calls ilAuthPageEditorGUI: ilLoginPageGUI, ilLogoutPageGUI

Definition at line 29 of file class.ilAuthPageEditorGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAuthPageEditorGUI::__construct ( int $a_ref_id )

Definition at line 50 of file class.ilAuthPageEditorGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
 
        $this->lng = $DIC['lng'];
 
        $this->lng->loadLanguageModule('auth');
 
        $this->ref_id = $a_ref_id;
 
        $content_style = $DIC->contentStyle();
        $this->content_style_domain = $content_style
            ->domain()
            ->styleForRefId($a_ref_id);
        $this->content_style_gui = $content_style->gui();
 
        $query_wrapper = $DIC->http()->wrapper()->query();
        $post_wrapper = $DIC->http()->wrapper()->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->requested_language_id = $post_wrapper->retrieve('key', $refinery->kindlyTo()->int());
        } elseif ($query_wrapper->has('key')) {
            $this->requested_language_id = $query_wrapper->retrieve('key', $refinery->kindlyTo()->int());
        }
 
        $this->request_ipe_context = $query_wrapper->retrieve(
            self::CONTEXT_HTTP_PARAM,
            $refinery->byTrying([
                $refinery->kindlyTo()->string(),
                $refinery->always(null)
            ])
        );
        $this->ctrl->setParameter($this, self::CONTEXT_HTTP_PARAM, $this->request_ipe_context);
    }

References $DIC, $refinery, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilAuthPageEditorGUI::activate ( )

private

Definition at line 250 of file class.ilAuthPageEditorGUI.php.

                               : void
    {
        $lang_keys = $this->getLangKeysToUpdate();
        $settings = ilAuthPageEditorSettings::getInstance(
            $this->getRequestedAuthPageEditorContext()
        );
 
        foreach ($lang_keys as $lang_key) {
            $settings->enableIliasEditor($lang_key, true);
        }
 
        $settings->update();
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::DEFAULT_COMMAND);
    }

References ILIAS\Repository\ctrl(), ilAuthPageEditorSettings\getInstance(), getLangKeysToUpdate(), getRequestedAuthPageEditorContext(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ deactivate()

ilAuthPageEditorGUI::deactivate ( )

private

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

                                 : void
    {
        $lang_keys = $this->getLangKeysToUpdate();
        $settings = ilAuthPageEditorSettings::getInstance(
            $this->getRequestedAuthPageEditorContext()
        );
 
        foreach ($lang_keys as $lang_key) {
            $settings->enableIliasEditor($lang_key, false);
        }
 
        $settings->update();
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::DEFAULT_COMMAND);
    }

References ILIAS\Repository\ctrl(), ilAuthPageEditorSettings\getInstance(), getLangKeysToUpdate(), getRequestedAuthPageEditorContext(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ executeCommand()

ilAuthPageEditorGUI::executeCommand ( )

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

                                    : void
    {
        switch (strtolower($this->ctrl->getNextClass($this) ?? '')) {
            case strtolower(ilLoginPageGUI::class):
            case strtolower(ilLogoutPageGUI::class):
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_COMMAND)
                );
 
                if (strtolower($this->redirect_source ?? '') !== strtolower(ilInternalLinkGUI::class)) {
                    $this->forwardToPageObject();
                }
                break;
 
            default:
                $cmd = $this->ctrl->getCmd();
                if ($cmd === null || $cmd === '' || !method_exists($this, $cmd . 'Command')) {
                    $cmd = self::DEFAULT_COMMAND;
                }
                $verified_command = $cmd . 'Command';
 
                $this->$verified_command();
                break;
        }
    }

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

Here is the call graph for this function:

◆ forwardToPageObject()

ilAuthPageEditorGUI::forwardToPageObject ( )

private

Definition at line 144 of file class.ilAuthPageEditorGUI.php.

                                          : void
    {
        if (!$this->requested_language_id) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('language_does_not_exist'),
                true
            );
            $this->ctrl->returnToParent($this);
        }
 
        $this->lng->loadLanguageModule('content');
 
        $this->tabs->activateSubTab($this->getRequestedAuthPageEditorContext()->tabIdentifier());
 
        $ipe_gui_class = $this->getRequestedAuthPageEditorContext()->pageUiClass();
        $ipe_class = $this->getRequestedAuthPageEditorContext()->pageClass();
        $ipe_page_type = $this->getRequestedAuthPageEditorContext()->pageType();
 
        $this->ctrl->setParameter($this, 'key', $this->requested_language_id);
 
        if (!$ipe_class::_exists($ipe_page_type, $this->requested_language_id)) {
            $new_page_object = new $ipe_class();
            $new_page_object->setParentId($this->requested_language_id);
            $new_page_object->setId($this->requested_language_id);
            $new_page_object->createFromXML();
        }
 
        $this->ctrl->setReturnByClass($ipe_gui_class, 'edit');
        $page_gui = new ($ipe_gui_class)($this->requested_language_id);
 
        $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
        $this->content_style_gui->addCss($this->tpl, $this->ref_id);
 
        $page_gui->setTemplateTargetVar('ADM_CONTENT');
        $page_gui->setStyleId($this->content_style_domain->getEffectiveStyleId());
        $page_gui->setTemplateOutput(false);
 
        $html = $this->ctrl->forwardCommand($page_gui);
 
        if ($html !== '') {
            $this->tpl->setContent($html);
        }
    }

References ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), getRequestedAuthPageEditorContext(), ilObjStyleSheet\getSyntaxStylePath(), 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:

◆ getLangKeysToUpdate()

ilAuthPageEditorGUI::getLangKeysToUpdate ( )

private

Returns: list<string>

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

                                          : array
    {
        $keys = $this->http->wrapper()->query()->retrieve(
            'authpage_languages_key',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                $this->refinery->always([])
            ])
        );
 
        $lang_keys = $this->lng->getInstalledLanguages();
 
        if ((string) current($keys) !== 'ALL_OBJECTS') {
            $lang_keys = array_intersect($keys, $lang_keys);
        }
 
        return $lang_keys;
    }

References ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by activate(), and deactivate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestedAuthPageEditorContext()

ilAuthPageEditorGUI::getRequestedAuthPageEditorContext ( )

private

Definition at line 139 of file class.ilAuthPageEditorGUI.php.

                                                        : AuthPageEditorContext
    {
        return AuthPageEditorContext::from($this->request_ipe_context);
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by activate(), deactivate(), forwardToPageObject(), handlePageActionsCommand(), and showPageEditorLanguagesCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSafePostCommands()

ilAuthPageEditorGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 106 of file class.ilAuthPageEditorGUI.php.

                                         : array
    {
        return [];
    }

◆ getUnsafeGetCommands()

ilAuthPageEditorGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [
           self::LANGUAGE_TABLE_ACTIONS_COMMAND,
        ];
    }

References LANGUAGE_TABLE_ACTIONS_COMMAND.

◆ handlePageActionsCommand()

ilAuthPageEditorGUI::handlePageActionsCommand ( )

private

Definition at line 190 of file class.ilAuthPageEditorGUI.php.

                                               : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            'authpage_languages_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
 
        $keys = $this->http->wrapper()->query()->retrieve(
            'authpage_languages_key',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                $this->refinery->always([])
            ])
        );
 
        switch ($action) {
            case AuthPageLanguagesOverviewTable::DEACTIVATE:
            case AuthPageLanguagesOverviewTable::ACTIVATE:
                $this->$action();
                break;
 
            case AuthPageLanguagesOverviewTable::EDIT:
                $language_id = ilLanguage::lookupId((string) current($keys));
                if ($language_id) {
                    $this->ctrl->setParameter($this, 'key', $language_id);
                    $this->ctrl->redirectByClass(
                        $this->getRequestedAuthPageEditorContext()->pageUiClass(),
                        'edit'
                    );
                }
        }
 
        $this->ctrl->redirect($this, self::DEFAULT_COMMAND);
    }

References ILIAS\Repository\ctrl(), getRequestedAuthPageEditorContext(), ILIAS\FileDelivery\http(), ilLanguage\lookupId(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ showPageEditorLanguagesCommand()

ilAuthPageEditorGUI::showPageEditorLanguagesCommand ( )

private

Definition at line 284 of file class.ilAuthPageEditorGUI.php.

                                                     : void
    {
        $this->tabs->activateSubTab($this->getRequestedAuthPageEditorContext()->tabIdentifier());
        $tbl = new AuthPageLanguagesOverviewTable(
            $this->ctrl,
            $this->lng,
            $this->http,
            $this->ui_factory,
            $this->ui_renderer,
            $this->getRequestedAuthPageEditorContext()
        );
 
        $this->tpl->setContent($this->ui_renderer->render($tbl->getComponent()));
    }