Inheritance diagram for ILIAS\Mail\UserSettings\NewMailNotification:

Collaboration diagram for ILIAS\Mail\UserSettings\NewMailNotification:

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, ?\ilPropertyFormGUI $form=null)

	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)

	getIdentifier ()

	getLabel (Language $lng)

	getSection ()

	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	mailOptionsFor (\ilObjUser $user)

Private Attributes
array	$mail_options_by_user = []

Detailed Description

Definition at line 31 of file NewMailNotification.php.

Member Function Documentation

◆ getDefaultValueForDisplay()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 99 of file NewMailNotification.php.

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

◆ getIdentifier()

ILIAS\Mail\UserSettings\NewMailNotification::getIdentifier ( )

Implements ILIAS\User\Property.

Definition at line 36 of file NewMailNotification.php.

                                   : string
    {
        return 'new_mail_notification';
    }

◆ getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 65 of file NewMailNotification.php.

     : Input {
        $lng->loadLanguageModule('mail');
 
        return $field_factory->checkbox(
            $this->getLabel($lng),
            $lng->txt('mail_cronjob_notification_info')
        )->withValue(
            $user !== null && $this->retrieveValueFromUser($user)
        );
    }

◆ getLabel()

ILIAS\Mail\UserSettings\NewMailNotification::getLabel ( Language $lng )

Implements ILIAS\User\Property.

Definition at line 50 of file NewMailNotification.php.

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

References $lng.

◆ getLegacyInput()

ILIAS\Mail\UserSettings\NewMailNotification::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 82 of file NewMailNotification.php.

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('mail');
 
        $input = new \ilCheckboxInputGUI($this->getLabel($lng));
        $input->setInfo($lng->txt('mail_cronjob_notification_info'));
        $input->setChecked(
            $user !== null && $this->retrieveValueFromUser($user)
        );
        $input->setValue('1');
 
        return $input;
    }

◆ getSection()

ILIAS\Mail\UserSettings\NewMailNotification::getSection ( )

Implements ILIAS\User\Property.

Definition at line 60 of file NewMailNotification.php.

                                : AvailableSections
    {
        return AvailableSections::Communication;
    }

◆ getSettingsPage()

ILIAS\Mail\UserSettings\NewMailNotification::getSettingsPage ( )

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 55 of file NewMailNotification.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

◆ hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 106 of file NewMailNotification.php.

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

◆ isAvailable()

ILIAS\Mail\UserSettings\NewMailNotification::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 41 of file NewMailNotification.php.

                                 : bool
    {
        $settings = new \ilSetting();
 
        return
            $settings->get('mail_notification') === '1' &&
            $settings->get('show_mail_settings') === '1';
    }

◆ mailOptionsFor()

ILIAS\Mail\UserSettings\NewMailNotification::mailOptionsFor ( \ilObjUser $user )

private

Definition at line 131 of file NewMailNotification.php.

                                                     : \ilMailOptions
    {
        if (!\array_key_exists($user->getId(), $this->mail_options_by_user)) {
            $this->mail_options_by_user[$user->getId()] = new \ilMailOptions($user->getId());
        }
 
        return $this->mail_options_by_user[$user->getId()];
    }

References ilObject\getId().

Here is the call graph for this function:

◆ persistUserInput()

ILIAS\Mail\UserSettings\NewMailNotification::persistUserInput	(	\ilObjUser	$user,
		mixed	$input,
		?\ilPropertyFormGUI	$form = `null`
	)

Definition at line 114 of file NewMailNotification.php.

     : \ilObjUser {
        $mail_options = $this->mailOptionsFor($user);
        $mail_options->setIsCronJobNotificationStatus($input === true || $input === '1');
        $mail_options->updateOptions();
 
        return $user;
    }

◆ retrieveValueFromUser()

ILIAS\Mail\UserSettings\NewMailNotification::retrieveValueFromUser ( \ilObjUser $user )

Implements ILIAS\User\Property.

Definition at line 126 of file NewMailNotification.php.

                                                           : bool
    {
        return $this->mailOptionsFor($user)->isCronJobNotificationEnabled();
    }

Field Documentation

◆ $mail_options_by_user

array ILIAS\Mail\UserSettings\NewMailNotification::$mail_options_by_user = []

private

Definition at line 34 of file NewMailNotification.php.

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

components/ILIAS/Mail/src/UserSettings/NewMailNotification.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ getDefaultValueForDisplay()

◆ getIdentifier()

◆ getInput()

◆ getLabel()

◆ getLegacyInput()

◆ getSection()

◆ getSettingsPage()

◆ hasUserPersonalizedSetting()

◆ isAvailable()

◆ mailOptionsFor()

◆ persistUserInput()

◆ retrieveValueFromUser()

Field Documentation

◆ $mail_options_by_user