NewMailNotification.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Mail\UserSettings;
 
use ILIAS\User\Settings\SettingDefinition;
use ILIAS\User\Settings\AvailablePages;
use ILIAS\User\Settings\AvailableSections;
use ILIAS\Language\Language;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\UI\Component\Input\Input;
use ILIAS\Refinery\Factory as Refinery;
 
class NewMailNotification implements SettingDefinition
{
    private array $mail_options_by_user = [];
 
    public function getIdentifier(): string
    {
        return 'new_mail_notification';
    }
 
    public function isAvailable(): bool
    {
        $settings = new \ilSetting();
 
        return
            $settings->get('mail_notification') === '1' &&
            $settings->get('show_mail_settings') === '1';
    }
 
    public function getLabel(Language $lng): string
    {
        return $lng->txt('cron_mail_notification');
    }
 
    public function getSettingsPage(): AvailablePages
    {
        return AvailablePages::MainSettings;
    }
 
    public function getSection(): AvailableSections
    {
        return AvailableSections::Communication;
    }
 
    public function getInput(
        FieldFactory $field_factory,
        Language $lng,
        Refinery $refinery,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): Input {
        $lng->loadLanguageModule('mail');
 
        return $field_factory->checkbox(
            $this->getLabel($lng),
            $lng->txt('mail_cronjob_notification_info')
        )->withValue(
            $user !== null && $this->retrieveValueFromUser($user)
        );
    }
 
    public function getLegacyInput(
        Language $lng,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): \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;
    }
 
    public function getDefaultValueForDisplay(
        Language $lng,
        \ilSetting $settings
    ): string {
        return $lng->txt('no');
    }
 
    public function hasUserPersonalizedSetting(
        \ilSetting $settings,
        \ilObjUser $user
    ): bool {
        $value = $this->retrieveValueFromUser($user);
        return $value !== false;
    }
 
    public function persistUserInput(
        \ilObjUser $user,
        mixed $input,
        ?\ilPropertyFormGUI $form = null
    ): \ilObjUser {
        $mail_options = $this->mailOptionsFor($user);
        $mail_options->setIsCronJobNotificationStatus($input === true || $input === '1');
        $mail_options->updateOptions();
 
        return $user;
    }
 
    public function retrieveValueFromUser(\ilObjUser $user): bool
    {
        return $this->mailOptionsFor($user)->isCronJobNotificationEnabled();
    }
 
    private function mailOptionsFor(\ilObjUser $user): \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()];
    }
}