Inheritance diagram for ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline:

Collaboration diagram for ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline:

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
	buildSetterValue (\ilSetting $settings, ?\ilObjUser $user)

Detailed Description

Definition at line 31 of file ShowStatusInWhoIsOnline.php.

Member Function Documentation

◆ buildSetterValue()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::buildSetterValue	(	\ilSetting	$settings,
		?\ilObjUser	$user
	)

private

Definition at line 144 of file ShowStatusInWhoIsOnline.php.

     : string {
        if ($user === null) {
            return $settings->get('hide_own_online_status', 'x');
        }
 
        $user_value = $user->getPref('hide_own_online_status');
        if (!empty($user_value)) {
            return $user_value;
        }
 
        return 'x';
    }

References ilSetting\get().

Here is the call graph for this function:

◆ getDefaultValueForDisplay()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 110 of file ShowStatusInWhoIsOnline.php.

     : string {
        return $settings->get('hide_own_online_status') === 'n'
            ? $lng->txt('user_awrn_show')
            : $lng->txt('user_awrn_hide');
    }

◆ getIdentifier()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::getIdentifier ( )

Implements ILIAS\User\Property.

Definition at line 33 of file ShowStatusInWhoIsOnline.php.

                                   : string
    {
        return 'awrn_user_show';
    }

Referenced by ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline\getLabel().

Here is the caller graph for this function:

◆ getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 58 of file ShowStatusInWhoIsOnline.php.

     : Input {
        $default = $settings->get('hide_own_online_status') === 'n'
            ? $lng->txt('user_awrn_show')
            : $lng->txt('user_awrn_hide');
 
        return $field_factory->select(
            $lng->txt('awrn_user_show'),
            [
                    'x' => "{$lng->txt('user_awrn_default')} ({$default})",
                    'n' => $lng->txt('user_awrn_show'),
                    'y' => $lng->txt('user_awrn_hide')
                ],
            $lng->txt('awrn_hide_from_awareness_info')
        )->withRequired(true)
            ->withValue($this->buildSetterValue($settings, $user));
    }

◆ getLabel()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::getLabel ( Language $lng )

Implements ILIAS\User\Property.

Definition at line 43 of file ShowStatusInWhoIsOnline.php.

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

References $lng, and ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline\getIdentifier().

Here is the call graph for this function:

◆ getLegacyInput()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::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 81 of file ShowStatusInWhoIsOnline.php.

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('awrn');
 
        $default = ($settings->get('hide_own_online_status') == 'n')
            ? $lng->txt('user_awrn_show')
            : $lng->txt('user_awrn_hide');
 
        $input = new \ilSelectInputGUI($lng->txt('awrn_user_show'), 'hide_own_online_status');
        $input->setOptions(
            [
                '' => $lng->txt('user_awrn_default') . ' (' . $default . ')',
                'n' => $lng->txt('user_awrn_show'),
                'y' => $lng->txt('user_awrn_hide')
            ]
        );
        $input->setDisabled((bool) $settings->get('usr_settings_disable_hide_own_online_status'));
        $input->setInfo($lng->txt('awrn_hide_from_awareness_info'));
        $input->setValue(
            $user !== null
                ? $user->getPref('chat_osc_accept_msg') === 'y'
                : $settings->get('chat_osc_accept_msg') === 'y'
        );
        return $input;
    }

◆ getSection()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::getSection ( )

Implements ILIAS\User\Property.

Definition at line 53 of file ShowStatusInWhoIsOnline.php.

                                : AvailableSections
    {
        return AvailableSections::Main;
    }

◆ getSettingsPage()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::getSettingsPage ( )

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 48 of file ShowStatusInWhoIsOnline.php.

                                     : AvailablePages
    {
        return AvailablePages::PrivacySettings;
    }

◆ hasUserPersonalizedSetting()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 119 of file ShowStatusInWhoIsOnline.php.

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

◆ isAvailable()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::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 ShowStatusInWhoIsOnline.php.

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

◆ persistUserInput()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::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 126 of file ShowStatusInWhoIsOnline.php.

     : \ilObjUser {
        if ($input === null) {
            $user->deletePref('hide_own_online_status');
            return $user;
        }
        $user->setPref('hide_own_online_status', $input);
        return $user;
    }

References ilObjUser\deletePref().

Here is the call graph for this function:

◆ retrieveValueFromUser()

ILIAS\Awareness\UserSettings\ShowStatusInWhoIsOnline::retrieveValueFromUser ( \ilObjUser $user )

Implements ILIAS\User\Property.

Definition at line 138 of file ShowStatusInWhoIsOnline.php.

                                                           : ?bool
    {
        $value = $user->getPref('hide_own_online_status');
        return $value !== null ? $value === 'n' : 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/Awareness/UserSettings/ShowStatusInWhoIsOnline.php

Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ buildSetterValue()

◆ getDefaultValueForDisplay()

◆ getIdentifier()

◆ getInput()

◆ getLabel()

◆ getLegacyInput()

◆ getSection()

◆ getSettingsPage()

◆ hasUserPersonalizedSetting()

◆ isAvailable()

◆ persistUserInput()

◆ retrieveValueFromUser()