ILIAS\User\Settings\User\SessionReminder Class Reference

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

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

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 ilSessionReminder	$session_reminder

Detailed Description

Definition at line 31 of file SessionReminder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\User\SessionReminder::__construct

(

)

Definition at line 35 of file SessionReminder.php.

    {
        $this->session_reminder = \ilSessionReminder::byLoggedInUser();
    }

References ilSessionReminder\byLoggedInUser().

Here is the call graph for this function:

Member Function Documentation

getDefaultValueForDisplay()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 120 of file SessionReminder.php.

     : string {
        return $this->session_reminder->getGlobalSessionReminderLeadTime() . ' ' . $lng->txt('minutes');
    }

getIdentifier()

ILIAS\User\Settings\User\SessionReminder::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 40 of file SessionReminder.php.

                                   : string
    {
        return 'session_reminder';
    }

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

Here is the caller graph for this function:

getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 65 of file SessionReminder.php.

     : Input {
        return $field_factory->numeric(
            $lng->txt('session_reminder_input'),
            sprintf(
                $lng->txt('session_reminder_lead_time_info'),
                \ilSessionReminder::LEAD_TIME_DISABLED,
                \ilSessionReminder::SUGGESTED_LEAD_TIME,
                \ilDatePresentation::secondsToString(\ilSession::getSessionExpireValue(), true)
            )
        )->withAdditionalTransformation(
            $refinery->int()->isGreaterThanOrEqual(
                \ilSessionReminder::LEAD_TIME_DISABLED
            )
        )->withAdditionalTransformation(
            $refinery->int()->isLessThanOrEqual(
                $this->session_reminder->getMaxPossibleLeadTime()
            )
        )->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : $this->session_reminder->getGlobalSessionReminderLeadTime()
        );
    }

getLabel()

ILIAS\User\Settings\User\SessionReminder::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 50 of file SessionReminder.php.

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

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

Here is the call graph for this function:

getLegacyInput()

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

     : \ilFormPropertyGUI {
        $input = new \ilNumberInputGUI($lng->txt('session_reminder_input'));
        $input->setInfo(
            sprintf(
                $lng->txt('session_reminder_lead_time_info'),
                \ilSessionReminder::LEAD_TIME_DISABLED,
                \ilSessionReminder::SUGGESTED_LEAD_TIME,
                \ilDatePresentation::secondsToString(\ilSession::getSessionExpireValue(), true)
            )
        );
        $input->setSize(3);
        $input->setMinValue(\ilSessionReminder::LEAD_TIME_DISABLED);
        $input->setMaxValue($this->session_reminder->getMaxPossibleLeadTime());
        $input->setValue(
            $user !== null
                ? (string) $this->retrieveValueFromUser($user)
                : (string) $this->session_reminder->getGlobalSessionReminderLeadTime()
        );
        return $input;
    }

getSection()

ILIAS\User\Settings\User\SessionReminder::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 60 of file SessionReminder.php.

                                : AvailableSections
    {
        return AvailableSections::Additional;
    }

References ILIAS\User\Settings\Additional.

getSettingsPage()

ILIAS\User\Settings\User\SessionReminder::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 55 of file SessionReminder.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 127 of file SessionReminder.php.

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

isAvailable()

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

                                 : bool
    {
        return true;
    }

persistUserInput()

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

     : \ilObjUser {
        $user->setPref(
            'session_reminder_lead_time',
            $input !== null ? (string) $input : (string) $this->session_reminder->getGlobalSessionReminderLeadTime()
        );
        return $user;
    }

retrieveValueFromUser()

ILIAS\User\Settings\User\SessionReminder::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 145 of file SessionReminder.php.

                                                           : int
    {
        return $this->session_reminder->getEffectiveLeadTime();
    }

Field Documentation

$session_reminder

readonly ilSessionReminder ILIAS\User\Settings\User\SessionReminder::$session_reminder

private

Definition at line 33 of file SessionReminder.php.

---

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

• components/ILIAS/User/src/Settings/User/SessionReminder.php