Class ilPersonalChatSettingsFormGUI. More...

Collaboration diagram for ilPersonalChatSettingsFormGUI:

Public Member Functions
	__construct ()
	ilPersonalChatSettingsFormGUI constructor. More...

	executeCommand ()

	isAccessible ()

	showChatOptions (Standard $form=null)

	saveChatOptions ()

Data Fields
const	PROP_ENABLE_OSC = 'chat_osc_accept_msg'

const	PROP_ENABLE_BROWSER_NOTIFICATIONS = 'chat_osc_browser_notifications'

const	PROP_ENABLE_SOUND = 'play_invitation_sound'

Protected Attributes
	$lng

	$ctrl

	$user

	$mainTpl

	$settings

	$chatSettings = array()

	$notificationSettings = array()

	$event

Private Member Functions
	shouldShowNotificationOptions ()

	shouldShowOnScreenChatOptions ()

	buildForm ()

	saveFormData (array $formData)

Private Attributes
	$uiFactory

	$uiRenderer

	$httpRequest

	$refinery

Detailed Description

Class ilPersonalChatSettingsFormGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de ilPersonalChatSettingsFormGUI: ilPersonalSettingsGUI

Definition at line 16 of file class.ilPersonalChatSettingsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPersonalChatSettingsFormGUI::__construct ( )

ilPersonalChatSettingsFormGUI constructor.

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

References $DIC, settings(), and user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->settings = $DIC['ilSetting'];
         $this->mainTpl = $DIC['tpl'];
         $this->lng = $DIC['lng'];
         $this->event = $DIC->event();
         $this->uiFactory = $DIC->ui()->factory();
         $this->uiRenderer = $DIC->ui()->renderer();
         $this->httpRequest = $DIC->http()->request();
         $this->refinery = $DIC->refinery();
 
         $this->lng->loadLanguageModule('chatroom');
         $this->lng->loadLanguageModule('chatroom_adm');
 
         $this->chatSettings = new ilSetting('chatroom');
         $this->notificationSettings = new ilSetting('notifications');
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

ilPersonalChatSettingsFormGUI::buildForm ( )

private

Returns: Standard

Definition at line 137 of file class.ilPersonalChatSettingsFormGUI.php.

References $section, settings(), shouldShowNotificationOptions(), shouldShowOnScreenChatOptions(), user(), and ilUtil\yn2tf().

Referenced by saveChatOptions(), and showChatOptions().

                                  : Standard
     {
         $fieldFactory = $this->uiFactory->input()->field();
 
         $fields = [];
 
         $checkboxStateToBooleanTrafo = $this->refinery->custom()->transformation(function ($v) {
             if (is_array($v)) {
                 return $v;
             }
 
             if (is_bool($v)) {
                 return $v;
             }
 
             return $v === 'checked';
         });
 
         if ($this->shouldShowOnScreenChatOptions()) {
             $oscAvailable = (bool) $this->settings->get('usr_settings_disable_chat_osc_accept_msg', false);
             $oscSubFormGroup = [];
 
             if ($this->chatSettings->get('enable_browser_notifications', false)) {
                 $enabledBrowserNotifications = $fieldFactory
                     ->checkbox(
                         $this->lng->txt('osc_enable_browser_notifications_label'),
                         sprintf(
                             $this->lng->txt('osc_enable_browser_notifications_info'),
                             (int) $this->chatSettings->get('conversation_idle_state_in_minutes')
                         )
                     )
                     ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                     ->withDisabled($oscAvailable);
 
                 $oscSubFormGroup[self::PROP_ENABLE_BROWSER_NOTIFICATIONS] = $enabledBrowserNotifications;
 
                 $groupValue = null;
                 if (ilUtil::yn2tf($this->user->getPref('chat_osc_accept_msg'))) {
                     $groupValue = [
                         self::PROP_ENABLE_BROWSER_NOTIFICATIONS => ilUtil::yn2tf($this->user->getPref('chat_osc_browser_notifications')),
                     ];
                 }
                 $enabledOsc = $fieldFactory
                     ->optionalGroup(
                         $oscSubFormGroup,
                         $this->lng->txt('chat_osc_accept_msg'),
                         $this->lng->txt('chat_osc_accept_msg_info')
                     )
                     ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                     ->withDisabled($oscAvailable)
                     ->withValue($groupValue);
             } else {
                 $enabledOsc = $fieldFactory
                     ->checkbox(
                         $this->lng->txt('chat_osc_accept_msg'),
                         $this->lng->txt('chat_osc_accept_msg_info')
                     )
                     ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                     ->withDisabled($oscAvailable)
                     ->withValue(ilUtil::yn2tf($this->user->getPref('chat_osc_accept_msg')));
             }
 
             $fields[self::PROP_ENABLE_OSC] = $enabledOsc;
         }
 
         if ($this->shouldShowNotificationOptions()) {
             $fields[self::PROP_ENABLE_SOUND] = $fieldFactory
                 ->checkbox($this->lng->txt('play_invitation_sound'), $this->lng->txt('play_invitation_sound_info'))
                 ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                 ->withValue((bool) $this->user->getPref('chat_play_invitation_sound'));
         }
 
         $section = $fieldFactory
             ->section($fields, $this->lng->txt('chat_settings'), '');
 
         return $this->uiFactory->input()
             ->container()
             ->form()
             ->standard(
                 $this->ctrl->getFormAction($this, 'saveChatOptions'),
                 [$section]
             )
             ->withAdditionalTransformation($this->refinery->custom()->transformation(function ($values) {
                 return call_user_func_array('array_merge', $values);
             }));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilPersonalChatSettingsFormGUI::executeCommand ( )

Definition at line 86 of file class.ilPersonalChatSettingsFormGUI.php.

References saveChatOptions(), and showChatOptions().

                                      : void
     {
         switch ($this->ctrl->getCmd()) {
             case 'saveChatOptions':
                 $this->saveChatOptions();
                 break;
 
             case 'showChatOptions':
             default:
                 $this->showChatOptions();
                 break;
         }
     }

Here is the call graph for this function:

◆ isAccessible()

ilPersonalChatSettingsFormGUI::isAccessible ( )

Returns: bool

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

References shouldShowNotificationOptions(), and shouldShowOnScreenChatOptions().

Referenced by saveChatOptions(), and showChatOptions().

                                    : bool
     {
         return (
             $this->chatSettings->get('chat_enabled', false) && (
                 $this->shouldShowNotificationOptions() || $this->shouldShowOnScreenChatOptions()
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveChatOptions()

ilPersonalChatSettingsFormGUI::saveChatOptions ( )

Definition at line 261 of file class.ilPersonalChatSettingsFormGUI.php.

References buildForm(), isAccessible(), saveFormData(), ilUtil\sendFailure(), and showChatOptions().

Referenced by executeCommand().

                                       : void
     {
         if (!$this->isAccessible()) {
             $this->ctrl->returnToParent($this);
         }
 
         $form = $this->buildForm();
 
         if ('POST' === $this->httpRequest->getMethod()) {
             $form = $form->withRequest($this->httpRequest);
 
             $formData = $form->getData();
             $update_possible = !is_null($formData);
             if ($update_possible) {
                 $this->saveFormData($formData);
             }
         }
 
         ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
         $this->showChatOptions($form);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveFormData()

ilPersonalChatSettingsFormGUI::saveFormData ( array $formData )

private

Definition at line 283 of file class.ilPersonalChatSettingsFormGUI.php.

References settings(), shouldShowNotificationOptions(), shouldShowOnScreenChatOptions(), ilUtil\tf2yn(), user(), and ilUtil\yn2tf().

Referenced by saveChatOptions().

                                                    : void
     {
         $preferencesUpdated = false;
 
         if ($this->shouldShowNotificationOptions()) {
             $oldPlaySoundValue = (int) $this->user->getPref('chat_play_invitation_sound');
             $playASound = (int) ($formData[self::PROP_ENABLE_SOUND] ?? 0);
 
             if ($oldPlaySoundValue !== $playASound) {
                 $this->user->setPref('chat_play_invitation_sound', $playASound);
                 $preferencesUpdated = true;
             }
         }
 
         if ($this->shouldShowOnScreenChatOptions()) {
             $oldEnableOscValue = ilUtil::yn2tf($this->user->getPref('chat_osc_accept_msg'));
             $enableOsc = $formData[self::PROP_ENABLE_OSC] ?? null;
             if (!is_bool($enableOsc)) {
                 $enableOsc = is_array($enableOsc);
             }
 
             if (!(bool) $this->settings->get('usr_settings_disable_chat_osc_accept_msg', false)) {
                 $preferencesUpdated = true;
                 if ($oldEnableOscValue !== $enableOsc) {
                     $this->user->setPref('chat_osc_accept_msg', ilUtil::tf2yn($enableOsc));
                     $preferencesUpdated = true;
                 }
             }
 
             if ($this->chatSettings->get('enable_browser_notifications', false) && $enableOsc) {
                 $oldBrowserNotificationValue = ilUtil::yn2tf($this->user->getPref('chat_osc_browser_notifications'));
 
                 $sendBrowserNotifications = false;
                 if (is_array($formData[self::PROP_ENABLE_OSC])) {
                     if (true === $formData[self::PROP_ENABLE_OSC][self::PROP_ENABLE_BROWSER_NOTIFICATIONS]) {
                         $sendBrowserNotifications = true;
                     }
                 }
 
                 if ($oldBrowserNotificationValue !== $sendBrowserNotifications) {
                     $this->user->setPref('chat_osc_browser_notifications', ilUtil::tf2yn($sendBrowserNotifications));
                     $preferencesUpdated = true;
                 }
             }
         }
 
         if ($preferencesUpdated) {
             $this->user->writePrefs();
 
             $this->event->raise(
                 'Modules/Chatroom',
                 'chatSettingsChanged',
                 [
                     'user' => $this->user
                 ]
             );
         }
 
         ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shouldShowNotificationOptions()

ilPersonalChatSettingsFormGUI::shouldShowNotificationOptions ( )

private

Returns: bool

Definition at line 115 of file class.ilPersonalChatSettingsFormGUI.php.

Referenced by buildForm(), isAccessible(), and saveFormData().

                                                      : bool
     {
         return (
             $this->notificationSettings->get('enable_osd', false) &&
             $this->chatSettings->get('play_invitation_sound', false)
         );
     }

Here is the caller graph for this function:

◆ shouldShowOnScreenChatOptions()

ilPersonalChatSettingsFormGUI::shouldShowOnScreenChatOptions ( )

private

Returns: bool

Definition at line 126 of file class.ilPersonalChatSettingsFormGUI.php.

References settings().

Referenced by buildForm(), isAccessible(), saveFormData(), and showChatOptions().

                                                      : bool
     {
         return (
             $this->chatSettings->get('enable_osc', false) &&
             !(bool) $this->settings->get('usr_settings_hide_chat_osc_accept_msg', false)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showChatOptions()

ilPersonalChatSettingsFormGUI::showChatOptions ( Standard $form = null )

Parameters

Standard | null $form

Exceptions

ilTemplateException

Definition at line 228 of file class.ilPersonalChatSettingsFormGUI.php.

References $mainTpl, $tpl, buildForm(), ilUtil\getImagePath(), isAccessible(), and shouldShowOnScreenChatOptions().

Referenced by executeCommand(), and saveChatOptions().

                                                            : void
     {
         if (!$this->isAccessible()) {
             $this->ctrl->returnToParent($this);
         }
 
         if (null === $form) {
             $form = $this->buildForm();
         }
 
         $tpl = new ilTemplate('tpl.personal_chat_settings_form.html', true, true, 'Modules/Chatroom');
         if ($this->shouldShowOnScreenChatOptions() && $this->chatSettings->get('enable_browser_notifications', false)) {
             $this->mainTpl->addJavascript('./Services/Notifications/js/browser_notifications.js');
 
             $tpl->setVariable('ALERT_IMAGE_SRC', ilUtil::getImagePath('icon_alert.svg'));
 
             $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'),
             ], $this->mainTpl);
         }
 
         $this->mainTpl->setContent($this->uiRenderer->render([
             $form,
             $this->uiFactory->legacy($tpl->get())
         ]));
         $this->mainTpl->printToStdout();
     }