ilAuthLogoutBehaviourGUI: ilObjAuthSettingsGUI ilAuthLogoutBehaviourGUI: ilLoginPageGUI More...

Collaboration diagram for ilAuthLogoutBehaviourGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	getForm (?ServerRequestInterface $request=null, array $errors=[])

	showForm ()

	saveForm ()

Private Attributes
ilCtrl	$ctrl

ilLanguage	$lng

HttpService	$http

Refinery	$refinery

ilSetting	$settings

UIFactory	$ui_factory

UIRenderer	$ui_renderer

ilGlobalTemplateInterface	$tpl

ConfigurableLogoutTarget	$configurable_logout_target

Detailed Description

ilAuthLogoutBehaviourGUI: ilObjAuthSettingsGUI ilAuthLogoutBehaviourGUI: ilLoginPageGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilAuthLogoutBehaviourGUI::__construct ( )

Definition at line 46 of file class.ilAuthLogoutBehaviourGUI.php.

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

     {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
         $this->http = $DIC->http();
         $this->lng = $DIC->language();
         $this->refinery = $DIC->refinery();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->lng->loadLanguageModule('auth');
         $this->settings = new ilSetting('auth');
         $this->configurable_logout_target = new ConfigurableLogoutTarget(
             $this->ctrl,
             $this->settings,
             $DIC->access()
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilAuthLogoutBehaviourGUI::executeCommand ( )

Definition at line 65 of file class.ilAuthLogoutBehaviourGUI.php.

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

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         if (method_exists($this, $cmd)) {
             $this->$cmd();
         }
         $this->showForm();
     }

Here is the call graph for this function:

◆ getForm()

ilAuthLogoutBehaviourGUI::getForm	(	?ServerRequestInterface	$request = `null`,
		array	$errors = `[]`
	)

Definition at line 74 of file class.ilAuthLogoutBehaviourGUI.php.

References $ref_id, $txt, $url, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by saveForm(), and showForm().

      : StandardForm {
         $logout_group = $this->ui_factory->input()->field()
             ->group(
                 [],
                 $this->lng->txt('destination_logout_screen')
             );
 
         $login_group = $this->ui_factory->input()->field()
             ->group(
                 [],
                 $this->lng->txt('destination_login_screen'),
                 $this->lng->txt('destination_login_screen_info')
             );
 
         $ref_id = $this->ui_factory->input()->field()
             ->numeric($this->lng->txt('destination_internal_ressource_ref_id'))
             ->withAdditionalTransformation(
                 $this->refinery->custom()->constraint(
                     fn($value) => $this->configurable_logout_target->isInRepository($value),
                     fn(callable $txt, $value) => $txt('logout_behaviour_invalid_ref_id', $value)
                 )
             )
             ->withAdditionalTransformation(
                 $this->refinery->custom()->constraint(
                     fn($value) => $this->configurable_logout_target->isAnonymousAccessible(
                         $value
                     ),
                     fn(callable $txt, $value) => $txt(
                         'logout_behaviour_ref_id_no_access',
                         $value
                     )
                 )
             )
             ->withValue($this->settings->get('logout_behaviour_ref_id', ''));
         if (isset($errors['ref_id'])) {
             $ref_id = $ref_id->withError($errors['ref_id']);
         }
 
         $internal_group = $this->ui_factory->input()->field()
             ->group(
                 ['ref_id' => $ref_id],
                 $this->lng->txt('destination_internal_ressource')
             );
 
         $url = $this->settings->get('logout_behaviour_url', '');
         $html = $this->ui_factory->input()->field()
             ->url($this->lng->txt('destination_external_ressource_url'))
             ->withAdditionalTransformation(
                 $this->refinery->custom()->constraint(
                     fn($value) => $this->configurable_logout_target->isValidExternalResource(
                         (string) $value
                     ),
                     fn(callable $txt, $value) => $txt('logout_behaviour_invalid_url', $value)
                 )
             )
             ->withValue($url);
         if (isset($errors['url'])) {
             $html = $html->withError($errors['url']);
         }
 
         $external_group = $this->ui_factory->input()->field()
             ->group(
                 ['url' => $html],
                 $this->lng->txt('destination_external_ressource')
             );
 
         $logout_behaviour_switchable_group = $this->ui_factory->input()->field()
             ->switchableGroup(
                 [
                     LogoutDestinations::LOGOUT_SCREEN->value => $logout_group,
                     LogoutDestinations::LOGIN_SCREEN->value => $login_group,
                     ConfigurableLogoutTarget::INTERNAL_RESSOURCE => $internal_group,
                     ConfigurableLogoutTarget::EXTERNAL_RESSOURCE => $external_group
                 ],
                 $this->lng->txt('destination_after_logout')
             )
             ->withValue(
                 $this->settings->get(
                     'logout_behaviour',
                     LogoutDestinations::LOGOUT_SCREEN->value
                 )
             );
 
         $section = $this->ui_factory->input()->field()
             ->section(
                 ['logout_behaviour_settings' => $logout_behaviour_switchable_group],
                 $this->lng->txt('logout_behaviour_settings')
             );
 
         $form = $this->ui_factory->input()->container()->form()
             ->standard(
                 $this->ctrl->getFormAction($this, 'saveForm'),
                 ['logout_behaviour' => $section]
             );
         if ($request) {
             $form = $form->withRequest($request);
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveForm()

ilAuthLogoutBehaviourGUI::saveForm ( )

Definition at line 196 of file class.ilAuthLogoutBehaviourGUI.php.

References $data, $ref_id, $url, ILIAS\Repository\ctrl(), getForm(), ILIAS\FileDelivery\http(), and ILIAS\Repository\settings().

                               : void
     {
         $form = $this->getForm();
         $form = $form->withRequest($this->http->request());
         $section = $form->getInputs()['logout_behaviour'];
         $group = $section->getInputs()['logout_behaviour_settings'];
         $ref_id = $group->getInputs()[ConfigurableLogoutTarget::INTERNAL_RESSOURCE]->getInputs()['ref_id'];
         $url = $group->getInputs()[ConfigurableLogoutTarget::EXTERNAL_RESSOURCE]->getInputs()['url'];
 
         $data = $form->getData();
         if (!$data || $form->getError() || $ref_id->getError() || $url->getError()) {
             $errors = [];
             if ($ref_id->getError()) {
                 $errors['ref_id'] = $ref_id->getError();
             }
             if ($url->getError()) {
                 $errors['url'] = $url->getError();
             }
             $this->tpl->setContent($this->ui_renderer->render($this->getForm($this->http->request(), $errors)));
             $this->tpl->printToStdout();
 
             $this->http->close();
         }
         if (isset($data['logout_behaviour']['logout_behaviour_settings'][0])) {
             $mode = $data['logout_behaviour']['logout_behaviour_settings'][0];
 
             switch ($mode) {
                 case LogoutDestinations::LOGIN_SCREEN->value:
                 case LogoutDestinations::LOGOUT_SCREEN->value:
                     break;
 
                 case ConfigurableLogoutTarget::INTERNAL_RESSOURCE:
                     $this->settings->set(
                         'logout_behaviour_ref_id',
                         (string) ($data['logout_behaviour']['logout_behaviour_settings'][1]['ref_id'] ?? '')
                     );
                     break;
                 case ConfigurableLogoutTarget::EXTERNAL_RESSOURCE:
 
                     $url = $data['logout_behaviour']['logout_behaviour_settings'][1]['url'] ?? '';
                     $this->settings->set('logout_behaviour_url', (string) $url);
                     break;
             }
             $this->settings->set('logout_behaviour', $mode);
         }
         $this->ctrl->redirect($this, 'showForm');
     }

Here is the call graph for this function:

◆ showForm()

ilAuthLogoutBehaviourGUI::showForm ( )

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

References $ref_id, getForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by executeCommand().

                               : void
     {
         $mode = $this->settings->get('logout_behaviour', LogoutDestinations::LOGOUT_SCREEN->value);
         $ref_id = (int) $this->settings->get('logout_behaviour_ref_id', '');
         $content = '';
         if ($mode === ConfigurableLogoutTarget::INTERNAL_RESSOURCE &&
             !$this->configurable_logout_target->isValidInternalResource($ref_id)) {
             $content .= $this->ui_renderer->render(
                 $this->ui_factory->messageBox()->failure(
                     $this->lng->txt('logout_behaviour_ref_id_valid_status_changed')
                 )
             );
         }
         $content .= $this->ui_renderer->render($this->getForm());
 
         $this->tpl->setContent($content);
     }