Feature: Design Logout Page

components/ILIAS/Authentication/classes/class.ilAuthLogoutPageEditorGUI.php

@@ -77,29 +77,31 @@ public function __construct(int $a_ref_id)
 
         $query_wrapper = $DIC->http()->wrapper()->query();
         $post_wrapper = $DIC->http()->wrapper()->post();
-        $is_post_request = $DIC->http()->request()->getMethod() === "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 ($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 ($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")) {
+            if ($post_wrapper->has('visible_languages')) {
                 $this->visible_languages = $post_wrapper->retrieve(
-                    "visible_languages", $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string())
+                    'visible_languages',
+                    $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string())
                 );
             }
 
-            if ($post_wrapper->has("languages")) {
+            if ($post_wrapper->has('languages')) {
                 $this->languages = $post_wrapper->retrieve(
-                    "languages", $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string())
+                    'languages',
+                    $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string())
                 );
             }
         }
@@ -117,16 +119,16 @@ public function getRefId(): int
 
     public function executeCommand(): void
     {
-        switch ($this->ctrl->getNextClass($this)) {
-            case 'illogoutpagegui':
+        switch (strtolower($this->ctrl->getNextClass($this))) {
+            case strtolower(ilLogoutPageGUI::class):
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt('back'),
                     $this->ctrl->getLinkTarget($this, 'show'),
                     '_top'
                 );
 
-                if ($this->redirect_source !== 'ilinternallinkgui') {
+                if ($this->redirect_source !== strtolower(ilInternalLinkGUI::class)) {
                     $this->forwardToPageObject();
                 }
                 break;
@@ -167,7 +169,7 @@ private function forwardToPageObject(): void
         $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
         $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
 
-        $this->ctrl->setReturnByClass('illogoutpagegui', 'edit');
+        $this->ctrl->setReturnByClass(ilLogoutPageGUI::class, 'edit');
         $page_gui = new ilLogoutPageGUI($this->key);
 
         $page_gui->setTemplateTargetVar('ADM_CONTENT');
@@ -177,19 +179,14 @@ private function forwardToPageObject(): void
 
         $html = $this->ctrl->forwardCommand($page_gui);
 
-        if ($html !== "") {
+        if ($html !== '') {
             $this->tpl->setContent($html);
         }
     }
 
     private function show(): void
     {
-        switch ($this->getSettings()->getMode()) {
-            case ilAuthLogoutPageEditorSettings::MODE_IPE:
-            default:
-                $this->showIliasEditor();
-                break;
-        }
+        $this->showIliasEditor();
     }
 
     private function handleLogoutPageActions(): void
@@ -220,7 +217,7 @@ private function handleLogoutPageActions(): void
             case 'edit':
                 $this->ctrl->setParameter($this, 'logoutpage_languages_key', current($keys));
                 $this->ctrl->setParameter($this, 'key', ilLanguage::lookupId(current($keys)));
-                $this->ctrl->redirectByClass('ilLogoutPageGUI', 'edit');
+                $this->ctrl->redirectByClass(ilLogoutPageGUI::class, 'edit');
                 break;
             default:
                 $this->ctrl->redirect($this, 'show');
@@ -292,15 +289,15 @@ private function showIliasEditor(): void
 
     private function saveLogoutInfo(): void
     {
-        if (!$this->rbacsystem->checkAccess("write", $this->getRefId())) {
-            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
+        if (!$this->rbacsystem->checkAccess('write', $this->getRefId())) {
+            $this->ilErr->raiseError($this->lng->txt('permission_denied'), $this->ilErr->MESSAGE);
         }
 
         $this->initLogoutForm();
         if ($this->form->checkInput()) {
-            $this->logoutSettings = new ilSetting("logout_settings");
+            $this->logoutSettings = new ilSetting('logout_settings');
             foreach ($this->lng->getInstalledLanguages() as $lang_key) {
-                $settingKey = "logout_message_" . $lang_key;
+                $settingKey = 'logout_message_' . $lang_key;
                 if ($this->form->getInput($settingKey)) {
                     $this->logoutSettings->set($settingKey, $this->form->getInput($settingKey));
                 }
@@ -310,7 +307,7 @@ private function saveLogoutInfo(): void
                 $this->setting->set('default_auth_mode', $this->form->getInput('default_auth_mode'));
             }
 
-            $this->tpl->setOnScreenMessage('success', $this->lng->txt("logout_information_settings_saved"), true);
+            $this->tpl->setOnScreenMessage('success', $this->lng->txt('logout_information_settings_saved'), true);
         }
 
         $this->ctrl->redirect($this, 'show');
@@ -326,7 +323,7 @@ private function initLogoutForm(): void
         $this->form->addCommandButton('saveLogoutInfo', $this->lng->txt('save'));
 
         if (!is_object($this->logoutSettings)) {
-            $this->logoutSettings = new ilSetting("logout_settings");
+            $this->logoutSettings = new ilSetting('logout_settings');
         }
 
         $logout_settings = $this->logoutSettings->getAll();
@@ -368,25 +365,22 @@ private function initLogoutForm(): void
             $textarea->setValue($message);
 
             if (!in_array($lang_key, $languages, true)) {
-                $textarea->setAlert($this->lng->txt("not_installed"));
+                $textarea->setAlert($this->lng->txt('not_installed'));
             }
 
             $this->form->addItem($textarea);
         }
     }
 
     /**
-     * returns an array of all installed languages, default language at the first position
-     * @param string $a_def_language Default language of the current installation
-     * @param array  $a_languages    Array of all installed languages
-     * @return 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
+     * @param string        $a_def_language
+     * @param array<string> $a_languages
+     * @return array<string>
      */
     private function setDefLangFirst(string $a_def_language, array $a_languages): array
     {
         $languages = [];
-        if ($a_def_language !== "") {
+        if ($a_def_language !== '') {
             $languages[] = $a_def_language;
 
             foreach ($a_languages as $val) {

components/ILIAS/Authentication/classes/class.ilAuthLogoutPageEditorSettings.php

@@ -20,15 +20,12 @@
 
 class ilAuthLogoutPageEditorSettings
 {
-    public const MODE_IPE = 2;
+    private static ?ilAuthLogoutPageEditorSettings $instance = null;
 
     private array $languages = [];
 
-    private static ?ilAuthLogoutPageEditorSettings $instance = null;
     private ilSetting $storage;
 
-    private int $mode = 0;
-
     private ilLanguage $lng;
 
     public function __construct()
@@ -42,27 +39,14 @@ public function __construct()
 
     public static function getInstance(): ilAuthLogoutPageEditorSettings
     {
-        if (self::$instance) {
-            return self::$instance;
-        }
-        return self::$instance = new ilAuthLogoutPageEditorSettings();
+        return self::$instance ?? new ilAuthLogoutPageEditorSettings();
     }
 
     protected function getStorage(): ilSetting
     {
         return $this->storage;
     }
 
-    public function setMode(int $a_mode): void
-    {
-        $this->mode = $a_mode;
-    }
-
-    public function getMode(): int
-    {
-        return $this->mode;
-    }
-
     public function getIliasEditorLanguage(string $a_langkey): string
     {
         if ($this->isIliasEditorEnabled($a_langkey)) {
@@ -86,20 +70,16 @@ public function isIliasEditorEnabled(string $a_langkey): bool
 
     public function update(): void
     {
-        $this->getStorage()->set('mode', (string) $this->getMode());
-
         foreach ($this->languages as $lngkey => $stat) {
             $this->storage->set($lngkey, (string) $stat);
         }
     }
 
     public function read(): void
     {
-        $this->setMode((int) $this->getStorage()->get('mode', (string) self::MODE_IPE));
-
         $this->languages = [];
         foreach ($this->lng->getInstalledLanguages() as $lngkey) {
-            $this->enableIliasEditor($lngkey, (bool) $this->getStorage()->get($lngkey, ""));
+            $this->enableIliasEditor($lngkey, (bool) $this->getStorage()->get($lngkey, ''));
         }
     }
 }