Inheritance diagram for ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations:

Collaboration diagram for ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations:

Public Member Functions
	getIdentifier ()

	isAvailable ()
	If this function returns `false` the setting will not be shown, even if it's `PropertyAttributes` would allow it to be. More...

	getLabel (Language $lng)

	getSettingsPage ()

	getSection ()

	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)

	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...

	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)

	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)

	persistUserInput (\ilObjUser $user, mixed $input)

	retrieveValueFromUser (\ilObjUser $user)

	isAvailable ()
	If this function returns `false` the setting will not be shown, even if it's `PropertyAttributes` would allow it to be. More...

	getSettingsPage ()

	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)

	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)

	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)

	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...

	persistUserInput (\ilObjUser $user, mixed $input)

	getIdentifier ()

	getLabel (Language $lng)

	getSection ()

	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildValueForNotificationGroup (\ilSetting $settings, ?\ilObjUser $user)

	updateChatServer (int $user_id, bool $osc_state)

Private Attributes
const string	KEY_ENABLE_BROWSER_NOTIFICATIONS = 'chat_osc_browser_notifications'

Detailed Description

Definition at line 31 of file AllowOnScreenChatConversations.php.

Member Function Documentation

◆ buildValueForNotificationGroup()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::buildValueForNotificationGroup	(	\ilSetting	$settings,
		?\ilObjUser	$user
	)

private

Definition at line 178 of file AllowOnScreenChatConversations.php.

     : ?array {
        $active = $settings->get($this->getIdentifier()) === 'y';
        $notification = false;
        if ($user !== null) {
            $active = $user->getPref($this->getIdentifier()) === 'y';
            $notification = $user->getPref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS) === 'y';
        }
 
        if ($active === false) {
            return null;
        }
 
        return [
            self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $notification
        ];
    }

References ilObjUser\getPref().

Here is the call graph for this function:

◆ getDefaultValueForDisplay()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 117 of file AllowOnScreenChatConversations.php.

     : string {
        return $lng->txt('chat_osc_accepts_messages_no');
    }

◆ getIdentifier()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getIdentifier ( )

Implements ILIAS\User\Property.

Definition at line 35 of file AllowOnScreenChatConversations.php.

                                   : string
    {
        return 'chat_osc_accept_msg';
    }

◆ getInput()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = `null`
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 60 of file AllowOnScreenChatConversations.php.

     : Input {
        $chat_settings = new \ilSetting('chatroom');
        $lng->loadLanguageModule('chatroom_adm');
 
        if ($chat_settings->get('enable_browser_notifications', '0') !== '1') {
            return $field_factory->checkbox(
                $lng->txt('chat_osc_accept_msg'),
                $lng->txt('chat_osc_accept_msg_info')
            )->withValue(
                $user !== null
                    ? $user->getPref('chat_osc_accept_msg') === 'y'
                    : $settings->get('chat_osc_accept_msg') === 'y'
            );
        }
 
        return $field_factory->optionalGroup(
            [
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $field_factory->checkbox(
                    $lng->txt('osc_enable_browser_notifications_label'),
                    \sprintf(
                        $lng->txt('osc_enable_browser_notifications_info'),
                        (int) $chat_settings->get('conversation_idle_state_in_minutes')
                    )
                )->withDisabled(
                    $settings->get('usr_settings_disable_chat_osc_accept_msg', '0') === '1'
                )
            ],
            $lng->txt('chat_osc_accept_msg'),
            $lng->txt('chat_osc_accept_msg_info')
        )->withValue(
            $this->buildValueForNotificationGroup($settings, $user)
        );
    }

References $lng, and ilSetting\get().

Here is the call graph for this function:

◆ getLabel()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getLabel ( Language $lng )

Implements ILIAS\User\Property.

Definition at line 45 of file AllowOnScreenChatConversations.php.

                                           : string
    {
        return $lng->txt('chat_osc_accept_msg');
    }

References $lng.

◆ getLegacyInput()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getLegacyInput	(	Language	$lng,
		\ilSetting	$settings,
		?\ilObjUser	$user = `null`
	)

You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed.

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 100 of file AllowOnScreenChatConversations.php.

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('chatroom');
 
        $input = new \ilCheckboxInputGUI($lng->txt('chat_osc_accept_msg'));
        $input->setChecked(
            $user !== null
                ? $user->getPref('chat_osc_accept_msg') === 'y'
                : $settings->get('chat_osc_accept_msg') === 'y'
        );
 
        return $input;
    }

◆ getSection()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getSection ( )

Implements ILIAS\User\Property.

Definition at line 55 of file AllowOnScreenChatConversations.php.

                                : AvailableSections
    {
        return AvailableSections::Main;
    }

◆ getSettingsPage()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::getSettingsPage ( )

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 50 of file AllowOnScreenChatConversations.php.

                                     : AvailablePages
    {
        return AvailablePages::PrivacySettings;
    }

◆ hasUserPersonalizedSetting()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 124 of file AllowOnScreenChatConversations.php.

     : bool {
        $user_value = $this->retrieveValueFromUser($user);
        return $user_value[$this->getIdentifier()] !== false;
    }

◆ isAvailable()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::isAvailable ( )

If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be.

This is meant e.g. to check if the chat server is configured or the badges enabled. Settings that are not available will also not be available on the table to define their PropertyAttributes

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 40 of file AllowOnScreenChatConversations.php.

                                 : bool
    {
        return (new \ilSetting('chatroom'))->get('enable_osc', '0') === '1';
    }

◆ persistUserInput()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::persistUserInput	(	\ilObjUser	$user,
		mixed	$input
	)

Parameters

mixed $input Null will be handed in, if the user wants to use the system default. If you are able to set the preference on the user without saving it, you can rely on the User-object being saved after the call to this function. If your input has different structures depending on its provenience (KS-Input, Legacy-Input, ...), the function needs to be able to handle them all.

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 132 of file AllowOnScreenChatConversations.php.

     : \ilObjUser {
        if ($input === null) {
            $user->deletePref($this->getIdentifier());
            $user->deletePref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS);
            $this->updateChatServer($user->getId(), false);
 
            return $user;
        }
 
        if (\is_bool($input)) {
            $user->setPref($this->getIdentifier(), $input ? 'y' : 'n');
            $this->updateChatServer($user->getId(), $input);
 
            return $user;
        }
 
        if (\is_array($input)) {
            $user->setPref($this->getIdentifier(), 'y');
            $user->setPref(
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS,
                $input[self::KEY_ENABLE_BROWSER_NOTIFICATIONS] ? 'y' : 'n'
            );
            $this->updateChatServer($user->getId(), true);
        }
 
        return $user;
    }

References ilObjUser\deletePref(), and ilObject\getId().

Here is the call graph for this function:

◆ retrieveValueFromUser()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::retrieveValueFromUser ( \ilObjUser $user )

Implements ILIAS\User\Property.

Definition at line 163 of file AllowOnScreenChatConversations.php.

                                                           : array
    {
        if ($user->getPref($this->getIdentifier()) !== 'y') {
            return [
                $this->getIdentifier() => false,
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS => false
            ];
        }
 
        return [
            $this->getIdentifier() => true,
            self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $user->getPref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS) === 'y'
        ];
    }

References ilObjUser\getPref().

Here is the call graph for this function:

◆ updateChatServer()

ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::updateChatServer	(	int	$user_id,
		bool	$osc_state
	)

private

Definition at line 198 of file AllowOnScreenChatConversations.php.

                                                                    : void
    {
        $message = [
            $user_id => [
                'acceptsMessages' => $osc_state,
            ]
        ];
 
        $settings = \ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
        $connector = new \ilChatroomServerConnector($settings);
        $connector->sendUserConfigChange(json_encode($message, JSON_THROW_ON_ERROR));
    }

References $message, $user_id, and ilChatroomAdmin\getDefaultConfiguration().

Here is the call graph for this function:

Field Documentation

◆ KEY_ENABLE_BROWSER_NOTIFICATIONS

const string ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations::KEY_ENABLE_BROWSER_NOTIFICATIONS = 'chat_osc_browser_notifications'

private

Definition at line 33 of file AllowOnScreenChatConversations.php.

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

components/ILIAS/Chatroom/src/UserSettings/AllowOnScreenChatConversations.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ buildValueForNotificationGroup()

◆ getDefaultValueForDisplay()

◆ getIdentifier()

◆ getInput()

◆ getLabel()

◆ getLegacyInput()

◆ getSection()

◆ getSettingsPage()

◆ hasUserPersonalizedSetting()

◆ isAvailable()

◆ persistUserInput()

◆ retrieveValueFromUser()

◆ updateChatServer()

Field Documentation

◆ KEY_ENABLE_BROWSER_NOTIFICATIONS