Inheritance diagram for ILIAS\Chatroom\UserSettings\BroadcastTyping:

Collaboration diagram for ILIAS\Chatroom\UserSettings\BroadcastTyping:

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)

Detailed Description

Definition at line 31 of file BroadcastTyping.php.

Member Function Documentation

◆ getDefaultValueForDisplay()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 95 of file BroadcastTyping.php.

     : string {
        return $settings->get($this->getIdentifier()) === 'y'
            ? $lng->txt('chat_use_typing_broadcast')
            : $lng->txt('chat_no_use_typing_broadcast');
    }

◆ getIdentifier()

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

Implements ILIAS\User\Property.

Definition at line 33 of file BroadcastTyping.php.

                                   : string
    {
        return 'chat_broadcast_typing';
    }

Referenced by ILIAS\Chatroom\UserSettings\BroadcastTyping\getLabel().

Here is the caller graph for this function:

◆ getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 58 of file BroadcastTyping.php.

     : Input {
        $lng->loadLanguageModule('chatroom_adm');
 
        return $field_factory->checkbox(
            $lng->txt('chat_broadcast_typing'),
            $lng->txt('chat_broadcast_typing_info')
        )->withValue(
            $user !== null
                ? $user->getPref('chat_broadcast_typing') === 'y'
                : $settings->get('chat_broadcast_typing') === 'y'
        );
    }

◆ getLabel()

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

Implements ILIAS\User\Property.

Definition at line 43 of file BroadcastTyping.php.

                                           : string
    {
        return $lng->txt($this->getIdentifier());
    }

References $lng, and ILIAS\Chatroom\UserSettings\BroadcastTyping\getIdentifier().

Here is the call graph for this function:

◆ getLegacyInput()

ILIAS\Chatroom\UserSettings\BroadcastTyping::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 77 of file BroadcastTyping.php.

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

◆ getSection()

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

Implements ILIAS\User\Property.

Definition at line 53 of file BroadcastTyping.php.

                                : AvailableSections
    {
        return AvailableSections::Main;
    }

◆ getSettingsPage()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 48 of file BroadcastTyping.php.

                                     : AvailablePages
    {
        return AvailablePages::PrivacySettings;
    }

◆ hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 104 of file BroadcastTyping.php.

     : bool {
        return $this->retrieveValueFromUser($user) !== $settings->get($this->getIdentifier());
    }

◆ isAvailable()

ILIAS\Chatroom\UserSettings\BroadcastTyping::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 38 of file BroadcastTyping.php.

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

◆ persistUserInput()

ILIAS\Chatroom\UserSettings\BroadcastTyping::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 111 of file BroadcastTyping.php.

     : \ilObjUser {
        if ($input === null) {
            $user->deletePref($this->getIdentifier());
 
            return $user;
        }
 
        $user->setPref($this->getIdentifier(), $input ? 'y' : 'n');
 
        return $user;
    }

References ilObjUser\deletePref().

Here is the call graph for this function:

◆ retrieveValueFromUser()

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

Implements ILIAS\User\Property.

Definition at line 126 of file BroadcastTyping.php.

                                                           : ?bool
    {
        $value = $user->getPref($this->getIdentifier());
 
        return $value !== null ? $value === 'y' : null;
    }

References ilObjUser\getPref().

Here is the call graph for this function:

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ getDefaultValueForDisplay()

◆ getIdentifier()

◆ getInput()

◆ getLabel()

◆ getLegacyInput()

◆ getSection()

◆ getSettingsPage()

◆ hasUserPersonalizedSetting()

◆ isAvailable()

◆ persistUserInput()

◆ retrieveValueFromUser()