ILIAS\User\Privacy\SettingsGUI Class Reference

Collaboration diagram for ILIAS\User\Privacy\SettingsGUI:

Public Member Functions
	__construct (private readonly \ilLanguage $lng, private readonly \ilCtrl $ctrl, private readonly \ilAppEventHandler $event, private readonly ServerRequestInterface $request, private readonly \ilObjUser $user, private readonly \ilSetting $settings, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly SettingsImplementation $user_settings, private readonly ProfileVisibility $profile_mode, private readonly ChecklistStatus $checklist_status, private readonly \ilSetting $chat_settings, private readonly \ilSetting $notification_settings)
	executeCommand ()
	showCmd (?StandardForm $form=null)
	saveCmd ()
	shouldDisplayChatSection ()
	shouldDisplayNotificationSection ()

Private Member Functions
	buildPrivacySettingsForm (?StandardForm $form)
	buildPublicProfilePresentation ()
	buildChatJsTemplate (\ilGlobalTemplateInterface $global_template)
	initForm ()
	shouldShowOnScreenChatOptions ()
	shouldShowChatTypingBroadcastOption ()
	shouldShowNotificationOptions ()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ILIAS\User\Privacy\SettingsGUI::__construct	(	private readonly \ilLanguage	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilAppEventHandler	$event,
		private readonly ServerRequestInterface	$request,
		private readonly \ilObjUser	$user,
		private readonly \ilSetting	$settings,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly SettingsImplementation	$user_settings,
		private readonly ProfileVisibility	$profile_mode,
		private readonly ChecklistStatus	$checklist_status,
		private readonly \ilSetting	$chat_settings,
		private readonly \ilSetting	$notification_settings
	)

Definition at line 36 of file class.SettingsGUI.php.

      {
    }

Member Function Documentation

buildChatJsTemplate()

ILIAS\User\Privacy\SettingsGUI::buildChatJsTemplate ( \ilGlobalTemplateInterface  $global_template )

private

Todo:

sk 2025-08-20: This is actually in the completely wrong place, but we will leave it here for the time being until a good solution to initialize the javascript without the need for a template is found.

Definition at line 133 of file class.SettingsGUI.php.

     : string {
        if (!$this->shouldShowOnScreenChatOptions()
            || $this->chat_settings->get('enable_browser_notifications', '0') !== '1') {
            return '';
        }
        $global_template->addJavaScript('assets/js/BrowserNotifications.min.js');
        $this->lng->toJSMap([
            'osc_browser_noti_no_permission_error' => $this->lng->txt('osc_browser_noti_no_permission_error'),
            'osc_browser_noti_no_support_error' => $this->lng->txt('osc_browser_noti_no_support_error'),
            'osc_browser_noti_req_permission_error' => $this->lng->txt('osc_browser_noti_req_permission_error'),
        ], $global_template);
 
        $tpl = new \ilTemplate('tpl.personal_chat_settings_form.html', true, true, 'components/ILIAS/Chatroom');
        $tpl->setVariable('ALERT_IMAGE_SRC', \ilUtil::getImagePath('standard/icon_alert.svg'));
        $tpl->setVariable('BROWSER_NOTIFICATION_TOGGLE_LABEL', $this->lng->txt('osc_enable_browser_notifications_label'));
        return $tpl->get();
    }

buildPrivacySettingsForm()

ILIAS\User\Privacy\SettingsGUI::buildPrivacySettingsForm ( ?StandardForm  $form )

private

Definition at line 94 of file class.SettingsGUI.php.

     : string {
        if ($form === null) {
            $form = $this->initForm();
        }
        return $this->ui_renderer->render($form);
    }

buildPublicProfilePresentation()

ILIAS\User\Privacy\SettingsGUI::buildPublicProfilePresentation ( )

private

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

                                                     : string
    {
        if ($this->profile_mode->isEnabled()) {
            $pub_profile_legacy = $this->ui_factory->legacy()->content(
                (new PublicProfileGUI(
                    $this->user->getId()
                ))->getEmbeddable()
            );
            return $this->ui_renderer->render($this->ui_factory->panel()->standard(
                $this->lng->txt('user_profile_preview'),
                $pub_profile_legacy
            ));
        }
 
        if (!$this->checklist_status->anyVisibilitySettings()) {
            return $this->ui_renderer->render(
                $this->ui_factory->messageBox()->info(
                    $this->lng->txt('usr_public_profile_disabled')
                )
            );
        }
 
        return '';
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

executeCommand()

ILIAS\User\Privacy\SettingsGUI::executeCommand

(

)

Definition at line 54 of file class.SettingsGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd('show') . 'Cmd';
        $this->$cmd();
        $this->tpl->printToStdout();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

initForm()

ILIAS\User\Privacy\SettingsGUI::initForm ( )

private

Definition at line 153 of file class.SettingsGUI.php.

                               : \ILIAS\UI\Component\Input\Container\Form\Standard
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getLinkTarget($this, 'save'),
            $this->user_settings->buildFormInputs(
                [AvailablePages::PrivacySettings],
                Context::User,
                $this->user
            )
        );
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

saveCmd()

ILIAS\User\Privacy\SettingsGUI::saveCmd

(

)

Definition at line 71 of file class.SettingsGUI.php.

                             : void
    {
        $form = $this->initForm()->withRequest($this->request);
        $form_data = [
            'privacy' => $form->getData()
        ];
 
        $updated_user = $this->user_settings->saveForm(
            $form_data,
            [AvailablePages::PrivacySettings],
            Context::User,
            $this->user
        );
 
        $this->checklist_status->setStepSucessOnUser(
            ChecklistStatus::STEP_VISIBILITY_OPTIONS,
            $updated_user
        )->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirectByClass(self::class, '');
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\User\Profile\ChecklistStatus\STEP_VISIBILITY_OPTIONS, and ILIAS\Repository\user().

Here is the call graph for this function:

shouldDisplayChatSection()

ILIAS\User\Privacy\SettingsGUI::shouldDisplayChatSection

(

)

Definition at line 176 of file class.SettingsGUI.php.

                                              : bool
    {
        return (bool) $this->chat_settings->get('chat_enabled', '0');
    }

shouldDisplayNotificationSection()

ILIAS\User\Privacy\SettingsGUI::shouldDisplayNotificationSection

(

)

Definition at line 186 of file class.SettingsGUI.php.

                                                      : bool
    {
        return (bool) $this->notification_settings->get('enable_osd', '0');
    }

shouldShowChatTypingBroadcastOption()

ILIAS\User\Privacy\SettingsGUI::shouldShowChatTypingBroadcastOption ( )

private

Definition at line 171 of file class.SettingsGUI.php.

                                                          : bool
    {
        return $this->settings->get('usr_settings_hide_chat_broadcast_typing', '0') !== '1';
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

shouldShowNotificationOptions()

ILIAS\User\Privacy\SettingsGUI::shouldShowNotificationOptions ( )

private

Definition at line 181 of file class.SettingsGUI.php.

                                                    : bool
    {
        return (bool) $this->notification_settings->get('osd_play_sound', '0');
    }

shouldShowOnScreenChatOptions()

ILIAS\User\Privacy\SettingsGUI::shouldShowOnScreenChatOptions ( )

private

Definition at line 165 of file class.SettingsGUI.php.

                                                    : bool
    {
        return $this->chat_settings->get('enable_osc', '0') &&
            $this->settings->get('usr_settings_hide_chat_osc_accept_msg', '0') !== 1;
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

showCmd()

ILIAS\User\Privacy\SettingsGUI::showCmd

(

?StandardForm

$form = null

)

Definition at line 61 of file class.SettingsGUI.php.

     : void {
        $this->tpl->setContent(
            $this->buildPrivacySettingsForm($form)
                . $this->buildPublicProfilePresentation()
                . $this->buildChatJsTemplate($this->tpl)
        );
    }

---

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

• components/ILIAS/User/src/Privacy/class.SettingsGUI.php