ILIAS\Help\UserSettings\Help Class Reference

Inheritance diagram for ILIAS\Help\UserSettings\Help:

Collaboration diagram for ILIAS\Help\UserSettings\Help:

Public Member Functions
	__construct ()
	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)
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	persistUserInput (\ilObjUser $user, mixed $input)
	retrieveValueFromUser (\ilObjUser $user)
Public Member Functions inherited from ILIAS\User\Settings\SettingDefinition
	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)
Public Member Functions inherited from ILIAS\User\Property
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Attributes
readonly ilHelpGUI	$help

Detailed Description

Definition at line 31 of file Help.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Help\UserSettings\Help::__construct

(

)

Definition at line 35 of file Help.php.

    {
        global $DIC;
        $this->help = $DIC['ilHelp'] ?? null;
    }

References $DIC, and ILIAS\Repository\help().

Here is the call graph for this function:

Member Function Documentation

getDefaultValueForDisplay()

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

Definition at line 100 of file Help.php.

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

getIdentifier()

ILIAS\Help\UserSettings\Help::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 41 of file Help.php.

                                   : string
    {
        return 'help';
    }

Referenced by ILIAS\Help\UserSettings\Help\getLabel().

Here is the caller graph for this function:

getInput()

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

Definition at line 66 of file Help.php.

     : Input {
        $lng->loadLanguageModule('help');
        return $field_factory->checkbox(
            $lng->txt('help_toggle_tooltips'),
            $lng->txt('help_toggle_tooltips_info')
        )->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : false
        );
    }

getLabel()

ILIAS\Help\UserSettings\Help::getLabel

(

Language

$lng

)

Definition at line 51 of file Help.php.

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

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

Here is the call graph for this function:

getLegacyInput()

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

Definition at line 84 of file Help.php.

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('help');
        $input = new \ilCheckboxInputGUI($lng->txt('help_toggle_tooltips'));
        $input->setInfo($lng->txt('help_toggle_tooltips_info'));
        $input->setChecked(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : false
        );
        return $input;
    }

getSection()

ILIAS\Help\UserSettings\Help::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 61 of file Help.php.

                                : AvailableSections
    {
        return AvailableSections::Additional;
    }

References ILIAS\User\Settings\Additional.

getSettingsPage()

ILIAS\Help\UserSettings\Help::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 56 of file Help.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 107 of file Help.php.

     : bool {
        return $this->retrieveValueFromUser($user) === true;
    }

isAvailable()

ILIAS\Help\UserSettings\Help::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 46 of file Help.php.

                                 : bool
    {
        return $this->help->areTooltipsActive();
    }

References ILIAS\Repository\help().

Here is the call graph for this function:

persistUserInput()

ILIAS\Help\UserSettings\Help::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 114 of file Help.php.

     : \ilObjUser {
        if ($this->help->areTooltipsActive()) {
            $user->setPref('hide_help_tt', (string) (int) $input);
        }
        return $user;
    }

References ilObjUser\setPref().

Here is the call graph for this function:

retrieveValueFromUser()

ILIAS\Help\UserSettings\Help::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 124 of file Help.php.

                                                           : bool
    {
        return $user->getPref('hide_help_tt') !== '1';
    }

References ilObjUser\getPref().

Here is the call graph for this function:

Field Documentation

$help

readonly ilHelpGUI ILIAS\Help\UserSettings\Help::$help

private

Definition at line 33 of file Help.php.

---

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

• components/ILIAS/Help/UserSettings/Help.php