Inheritance diagram for ILIAS\User\Settings\User\LastVisited:

Collaboration diagram for ILIAS\User\Settings\User\LastVisited:

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)
	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 Attributes
readonly ilNavigationHistory	$navigation_history

Detailed Description

Definition at line 31 of file LastVisited.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\User\Settings\User\LastVisited::__construct ( )

Definition at line 35 of file LastVisited.php.

    {
        global $DIC;
        $this->navigation_history = $DIC['ilNavigationHistory'] ?? null;
    }

References $DIC.

Member Function Documentation

◆ getDefaultValueForDisplay()

ILIAS\User\Settings\User\LastVisited::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 108 of file LastVisited.php.

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

◆ getIdentifier()

ILIAS\User\Settings\User\LastVisited::getIdentifier ( )

Implements ILIAS\User\Property.

Definition at line 41 of file LastVisited.php.

                                   : string
    {
        return 'last_visited';
    }

Referenced by ILIAS\User\Settings\User\LastVisited\getLabel().

Here is the caller graph for this function:

◆ getInput()

ILIAS\User\Settings\User\LastVisited::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = `null`
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 66 of file LastVisited.php.

     : Input {
        return $field_factory->select(
            $lng->txt('user_store_last_visited'),
            [
                0 => $lng->txt('user_lv_keep_entries'),
                1 => $lng->txt('user_lv_keep_only_for_session'),
                2 => $lng->txt('user_lv_do_not_store')
            ]
        )->withRequired(true)
        ->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : 0
        );
    }

◆ getLabel()

ILIAS\User\Settings\User\LastVisited::getLabel ( Language $lng )

Implements ILIAS\User\Property.

Definition at line 51 of file LastVisited.php.

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

References $lng, and ILIAS\User\Settings\User\LastVisited\getIdentifier().

Here is the call graph for this function:

◆ getLegacyInput()

ILIAS\User\Settings\User\LastVisited::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 88 of file LastVisited.php.

     : \ilFormPropertyGUI {
        $input = new \ilSelectInputGUI($lng->txt('user_store_last_visited'));
        $options = [
            0 => $lng->txt('user_lv_keep_entries'),
            1 => $lng->txt('user_lv_keep_only_for_session'),
            2 => $lng->txt('user_lv_do_not_store')
        ];
        $input->setOptions($options);
        $input->setValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : 0
        );
        return $input;
    }

◆ getSection()

ILIAS\User\Settings\User\LastVisited::getSection ( )

Implements ILIAS\User\Property.

Definition at line 61 of file LastVisited.php.

                                : AvailableSections
    {
        return AvailableSections::Additional;
    }

References ILIAS\User\Settings\Additional.

◆ getSettingsPage()

ILIAS\User\Settings\User\LastVisited::getSettingsPage ( )

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 56 of file LastVisited.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

◆ hasUserPersonalizedSetting()

ILIAS\User\Settings\User\LastVisited::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 115 of file LastVisited.php.

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

◆ isAvailable()

ILIAS\User\Settings\User\LastVisited::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 LastVisited.php.

                                 : bool
    {
        return true;
    }

◆ persistUserInput()

ILIAS\User\Settings\User\LastVisited::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 122 of file LastVisited.php.

     : \ilObjUser {
        $user->setPref('store_last_visited', $input ?? '0');
        if ((int) $input > 0) {
            $this->navigation_history->deleteDBEntries();
            if ($input === '2') {
                $this->navigation_history->deleteSessionEntries();
            }
        }
        return $user;
    }

◆ retrieveValueFromUser()

ILIAS\User\Settings\User\LastVisited::retrieveValueFromUser ( \ilObjUser $user )

Implements ILIAS\User\Property.

Definition at line 136 of file LastVisited.php.

                                                           : int
    {
        return (int) ($user->getPref('store_last_visited') ?? 0);
    }

References ilObjUser\getPref().

Here is the call graph for this function:

Field Documentation

◆ $navigation_history

readonly ilNavigationHistory ILIAS\User\Settings\User\LastVisited::$navigation_history

private

Definition at line 33 of file LastVisited.php.

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

components/ILIAS/User/src/Settings/User/LastVisited.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultValueForDisplay()

◆ getIdentifier()

◆ getInput()

◆ getLabel()

◆ getLegacyInput()

◆ getSection()

◆ getSettingsPage()

◆ hasUserPersonalizedSetting()

◆ isAvailable()

◆ persistUserInput()

◆ retrieveValueFromUser()

Field Documentation

◆ $navigation_history