Inheritance diagram for ilMailCronNotification:

Collaboration diagram for ilMailCronNotification:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	hasCustomSettings ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, ilLanguage $lng)

	saveCustomConfiguration (mixed $form_data)

	run ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?JobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	saveCustomSettings (\ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (\ilDBInterface $db, \ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Protected Member Functions
	init ()

Protected Attributes
ilLanguage	$lng

ilSetting	$settings

bool	$init_done = false

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
GlobalHttpState	$http

Detailed Description

Definition at line 26 of file class.ilMailCronNotification.php.

Member Function Documentation

◆ activationWasToggled()

ilMailCronNotification::activationWasToggled	(	ilDBInterface	$db,
		ilSetting	$setting,
		bool	$a_currently_active
	)

Definition at line 145 of file class.ilMailCronNotification.php.

                                                                                                         : void
    {
        $setting->set('mail_notification', (string) ((int) $a_currently_active));
    }

References ilSetting\set().

Here is the call graph for this function:

◆ addCustomSettingsToForm()

ilMailCronNotification::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 135 of file class.ilMailCronNotification.php.

                                                                      : void
    {
        throw new RuntimeException('Not implemented');
    }

◆ getCustomConfigurationInput()

ilMailCronNotification::getCustomConfigurationInput	(	\ILIAS\UI\Factory	$ui_factory,
		\ILIAS\Refinery\Factory	$factory,
		ilLanguage	$lng
	)

Definition at line 100 of file class.ilMailCronNotification.php.

     : \ILIAS\UI\Component\Input\Container\Form\FormInput {
        $status = $ui_factory
            ->input()
            ->field()
            ->checkbox($this->lng->txt('cron_mail_notification_message'))
            ->withByline($this->lng->txt('cron_mail_notification_message_info'))
            ->withValue((bool) $this->settings->get('mail_notification_message', '0'))
            ->withDedicatedName('mail_notification_message');
 
        return $status;
    }

◆ getDefaultScheduleType()

ilMailCronNotification::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 70 of file class.ilMailCronNotification.php.

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilMailCronNotification::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 75 of file class.ilMailCronNotification.php.

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilMailCronNotification::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 58 of file class.ilMailCronNotification.php.

                                    : string
    {
        $this->init();
 
        $this->lng->loadLanguageModule('mail');
 
        return  sprintf(
            $this->lng->txt('cron_mail_notification_desc'),
            $this->lng->txt('mail_allow_external')
        );
    }

References init(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilMailCronNotification::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 46 of file class.ilMailCronNotification.php.

                           : string
    {
        return 'mail_notification';
    }

◆ getTitle()

ilMailCronNotification::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 51 of file class.ilMailCronNotification.php.

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

References init(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilMailCronNotification::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 80 of file class.ilMailCronNotification.php.

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilMailCronNotification::hasCustomSettings ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 90 of file class.ilMailCronNotification.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilMailCronNotification::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 85 of file class.ilMailCronNotification.php.

                                         : bool
    {
        return false;
    }

◆ init()

ilMailCronNotification::init ( )

protected

Definition at line 33 of file class.ilMailCronNotification.php.

                             : void
    {
        global $DIC;
 
        if (!$this->init_done) {
            $this->settings = $DIC->settings();
            $this->lng = $DIC->language();
            $this->http = $DIC->http();
 
            $this->init_done = true;
        }
    }

References $DIC, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by getDescription(), and getTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilMailCronNotification::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 125 of file class.ilMailCronNotification.php.

                         : JobResult
    {
        $msn = new ilMailSummaryNotification();
        $msn->send();
 
        $result = new JobResult();
        $result->setStatus(JobResult::STATUS_OK);
        return $result;
    }

◆ saveCustomConfiguration()

ilMailCronNotification::saveCustomConfiguration ( mixed $form_data )

Parameters

mixed $form_data The form data provided by the KS (\ILIAS\UI\Component\Input\Container\Container::getData)). The types and structure depend on the structure provided by getCustomConfigurationInput. It might be a single value or a array<string, mixed>-like structure.

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 116 of file class.ilMailCronNotification.php.

                                                             : void
    {
        $this->init();
        $this->settings->set(
            'mail_notification_message',
            (string) ((int) $form_data)
        );
    }

References init(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveCustomSettings()

ilMailCronNotification::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 140 of file class.ilMailCronNotification.php.

                                                                 : bool
    {
        throw new RuntimeException('Not implemented');
    }

◆ usesLegacyForms()

ilMailCronNotification::usesLegacyForms ( )

Deprecated:

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 95 of file class.ilMailCronNotification.php.

                                     : bool
    {
        return false;
    }

Field Documentation

◆ $http

GlobalHttpState ilMailCronNotification::$http

private

Definition at line 28 of file class.ilMailCronNotification.php.

◆ $init_done

bool ilMailCronNotification::$init_done = false

protected

Definition at line 31 of file class.ilMailCronNotification.php.

◆ $lng

ilLanguage ilMailCronNotification::$lng

protected

Definition at line 29 of file class.ilMailCronNotification.php.

◆ $settings

ilSetting ilMailCronNotification::$settings

protected

Definition at line 30 of file class.ilMailCronNotification.php.

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

components/ILIAS/Mail/classes/class.ilMailCronNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ getCustomConfigurationInput()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ init()

◆ run()

◆ saveCustomConfiguration()

◆ saveCustomSettings()

◆ usesLegacyForms()

Field Documentation

◆ $http

◆ $init_done

◆ $lng

◆ $settings