ILIAS\Mail\UserSettings\IncomingMail Class Reference

Inheritance diagram for ILIAS\Mail\UserSettings\IncomingMail:

Collaboration diagram for ILIAS\Mail\UserSettings\IncomingMail:

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
	buildTransformation (Refinery $refinery, ?\ilObjUser $user=null)
	buildValueSetterArray (\ilSetting $settings, ?\ilObjUser $user=null)
	buildEmailInputs (Language $lng, FieldFactory $field_factory, ?\ilObjUser $user)
	mailOptionsFor (\ilObjUser $user)

Private Attributes
array	$mail_options_by_user = []

Detailed Description

Definition at line 32 of file IncomingMail.php.

Member Function Documentation

buildEmailInputs()

ILIAS\Mail\UserSettings\IncomingMail::buildEmailInputs ( Language  $lng, FieldFactory  $field_factory, ?\ilObjUser  $user  )

private

Definition at line 268 of file IncomingMail.php.

     : array {
        if ($user === null || ($user->getEmail() === '' && $user->getSecondEmail() === '')) {
            return [];
        }
 
        return [
            'mail_address_option' => $field_factory
                ->radio(
                    $lng->txt('email')
                )
                ->withOption(
                    (string) \ilMailOptions::FIRST_EMAIL,
                    $lng->txt('mail_first_email'),
                    $user->getEmail() === ''
                        ? $lng->txt('first_email_missing_info')
                        : $user->getEmail()
                )
                ->withOption(
                    (string) \ilMailOptions::SECOND_EMAIL,
                    $lng->txt('mail_second_email'),
                    $user->getSecondEmail() === ''
                        ? $lng->txt('second_email_missing_info')
                        : $user->getSecondEmail()
                )
                ->withOption((string) \ilMailOptions::BOTH_EMAIL, $lng->txt('mail_both_email'))
        ];
    }

buildTransformation()

ILIAS\Mail\UserSettings\IncomingMail::buildTransformation ( Refinery  $refinery, ?\ilObjUser  $user = null  )

private

Definition at line 211 of file IncomingMail.php.

     : Transformation {
        return $refinery->custom()->transformation(
            function (array $v) use ($refinery, $user): array {
                $email_address_option = $v[1]['mail_address_option'] ?? null;
                if ($user !== null) {
                    if ($user->getEmail() !== '' && $user->getSecondEmail() === '') {
                        $email_address_option = \ilMailOptions::FIRST_EMAIL;
                    } elseif ($user->getSecondEmail() !== '' && $user->getEmail() === '') {
                        $email_address_option = \ilMailOptions::SECOND_EMAIL;
                    }
                }
 
                $incoming_type = $refinery->kindlyTo()->int()->transform($v[0]);
                if ($email_address_option === null) {
                    $incoming_type = \ilMailOptions::INCOMING_LOCAL;
                }
 
                return [
                    'incoming_mail' => $incoming_type,
                    'mail_address_option' => $email_address_option === null && $user !== null
                        ? $this->mailOptionsFor($user)->getStoredEmailAddressMode()
                        : $refinery->byTrying([
                            $refinery->kindlyTo()->int(),
                            $refinery->always(null)
                        ])->transform($email_address_option)
                ];
            }
        );
    }

References ilMailOptions\FIRST_EMAIL, ilObjUser\getEmail(), ilObjUser\getSecondEmail(), and ilMailOptions\SECOND_EMAIL.

Here is the call graph for this function:

buildValueSetterArray()

ILIAS\Mail\UserSettings\IncomingMail::buildValueSetterArray ( \ilSetting  $settings, ?\ilObjUser  $user = null  )

private

Definition at line 244 of file IncomingMail.php.

     : int|array {
        $value = $user !== null
            ? $this->retrieveValueFromUser($user)
            : [
                'incoming_mail' => (int) $settings->get('mail_incoming_mail', (string) \ilMailOptions::INCOMING_LOCAL),
                'mail_address_option' => (int) $settings->get('mail_address_option', (string) \ilMailOptions::FIRST_EMAIL)
            ];
 
        if ($value['incoming_mail'] === \ilMailOptions::INCOMING_LOCAL ||
            ($user->getEmail() === '' && $user->getSecondEmail() === '')) {
            return $value['incoming_mail'];
        }
 
        return [
            0 => $value['incoming_mail'],
            1 => [
                'mail_address_option' => $value['mail_address_option']
            ]
        ];
    }

getDefaultValueForDisplay()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 124 of file IncomingMail.php.

     : string {
        $setting = (int) $settings->get('mail_incoming_mail', (string) \ilMailOptions::INCOMING_LOCAL);
        $value = match ($setting) {
            \ilMailOptions::INCOMING_LOCAL => $lng->txt('mail_incoming_local'),
            \ilMailOptions::INCOMING_EMAIL => $lng->txt('mail_incoming_smtp'),
            \ilMailOptions::INCOMING_BOTH => $lng->txt('mail_incoming_both')
        };
        if ($setting === \ilMailOptions::INCOMING_LOCAL) {
            return $value;
        }
 
        return match ((int) $settings->get('mail_address_option', (string) \ilMailOptions::FIRST_EMAIL)) {
            \ilMailOptions::FIRST_EMAIL => "{$value}: {$lng->txt('mail_first_email')}",
            \ilMailOptions::SECOND_EMAIL => "{$value}: {$lng->txt('mail_second_email')}",
            \ilMailOptions::BOTH_EMAIL => "{$value}: {$lng->txt('mail_both_email')}",
        };
    }

References $lng, ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, and ilMailOptions\INCOMING_LOCAL.

getIdentifier()

ILIAS\Mail\UserSettings\IncomingMail::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 37 of file IncomingMail.php.

                                   : string
    {
        return 'incoming_mail';
    }

getInput()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 62 of file IncomingMail.php.

     : Input {
        $lng->loadLanguageModule('mail');
 
        $inputs = $this->buildEmailInputs($lng, $field_factory, $user);
 
        return $field_factory->switchableGroup(
            [
                \ilMailOptions::INCOMING_LOCAL => $field_factory->group([], $lng->txt('mail_incoming_local')),
                \ilMailOptions::INCOMING_EMAIL => $field_factory->group(
                    $inputs,
                    $lng->txt('mail_incoming_smtp')
                )->withDisabled(
                    $user === null || (
                        $user->getEmail() === '' &&
                        $user->getSecondEmail() === ''
                    )
                ),
                \ilMailOptions::INCOMING_BOTH => $field_factory->group(
                    $inputs,
                    $lng->txt('mail_incoming_both')
                )->withDisabled(
                    $user === null || (
                        $user->getEmail() === '' &&
                        $user->getSecondEmail() === ''
                    )
                )
            ],
            $lng->txt('mail_incoming')
        )->withAdditionalTransformation(
            $this->buildTransformation($refinery, $user)
        )->withValue(
            $this->buildValueSetterArray($settings, $user)
        );
    }

getLabel()

ILIAS\Mail\UserSettings\IncomingMail::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 47 of file IncomingMail.php.

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

References $lng.

getLegacyInput()

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

     : \ilFormPropertyGUI {
        $lng->loadLanguageModule('mail');
 
        $input = new \ilIncomingMailInputGUI($lng->txt('mail_incoming'), 'incoming_mail');
        $input->setFreeOptionChoice(false);
        $input->setValueByArray(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : [
                    'incoming_mail' => (int) $settings->get('mail_incoming_mail', (string) \ilMailOptions::INCOMING_LOCAL),
                    'mail_address_option' => (int) $settings->get('mail_address_option', (string) \ilMailOptions::FIRST_EMAIL)
                ]
        );
 
        return $input;
    }

getSection()

ILIAS\Mail\UserSettings\IncomingMail::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 57 of file IncomingMail.php.

                                : AvailableSections
    {
        return AvailableSections::Communication;
    }

getSettingsPage()

ILIAS\Mail\UserSettings\IncomingMail::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 52 of file IncomingMail.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

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

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 145 of file IncomingMail.php.

     : bool {
        $current = $this->retrieveValueFromUser($user);
        $default = [
            'incoming_mail' => (int) $settings->get('mail_incoming_mail', (string) \ilMailOptions::INCOMING_LOCAL),
            'mail_address_option' => (int) $settings->get('mail_address_option', (string) \ilMailOptions::FIRST_EMAIL)
        ];
 
        return $current !== $default;
    }

isAvailable()

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

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

mailOptionsFor()

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

private

Definition at line 300 of file IncomingMail.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\IncomingMail::persistUserInput	(	\ilObjUser	$user,
		mixed	$input,
		?\ilPropertyFormGUI	$form = null
	)

Definition at line 158 of file IncomingMail.php.

     : \ilObjUser {
        $mail_options = $this->mailOptionsFor($user);
        if ($input === null) {
            $settings = new \ilSetting();
            $mail_options->setIncomingType(
                (int) $settings->get('mail_incoming_mail', (string) \ilMailOptions::INCOMING_LOCAL)
            );
            $mail_options->setEmailAddressmode(
                (int) $settings->get('mail_address_option', (string) \ilMailOptions::FIRST_EMAIL)
            );
            $mail_options->updateOptions();
 
            return $user;
        }
 
        $incoming_type = \is_array($input) ? $input['incoming_mail'] : (int) $input;
        $mail_options->setIncomingType($incoming_type);
        if ((int) $input === \ilMailOptions::INCOMING_LOCAL) {
            $mail_options->updateOptions();
 
            return $user;
        }
 
        if (\is_array($input)) {
            $address_mode = $input['mail_address_option'];
        } elseif ($form !== null) {
            $address_mode = (int) $form->getInput('mail_address_option');
        } else {
            $address_mode = $mail_options->getEmailAddressMode();
        }
        if (\is_int($address_mode)) {
            $mail_options->setEmailAddressmode($address_mode);
        }
 
        $mail_options->updateOptions();
 
        return $user;
    }

References ilMailOptions\FIRST_EMAIL, ilSetting\get(), and ilMailOptions\INCOMING_LOCAL.

Here is the call graph for this function:

retrieveValueFromUser()

ILIAS\Mail\UserSettings\IncomingMail::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 201 of file IncomingMail.php.

                                                           : ?array
    {
        $mail_options = $this->mailOptionsFor($user);
 
        return [
            'incoming_mail' => $mail_options->getIncomingType(),
            'mail_address_option' => $mail_options->getEmailAddressMode()
        ];
    }

Field Documentation

$mail_options_by_user

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

private

Definition at line 35 of file IncomingMail.php.

---

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

• components/ILIAS/Mail/src/UserSettings/IncomingMail.php