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 ()

	run ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	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...

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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 ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	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	$initDone = false

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
GlobalHttpState	$http

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

Mail notifications.

Author: Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

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

Member Function Documentation

◆ activationWasToggled()

ilMailCronNotification::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.

Furthermore only few dependencies may be available in the $DIC.

Parameters

ilDBInterface	$db
ilSetting	$setting
bool	$a_currently_active

Returns: void

Reimplemented from ilCronJob.

Definition at line 128 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 )

Reimplemented from ilCronJob.

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

                                                                      : void
    {
        $this->init();
        $cb = new ilCheckboxInputGUI(
            $this->lng->txt('cron_mail_notification_message'),
            'mail_notification_message'
        );
        $cb->setInfo($this->lng->txt('cron_mail_notification_message_info'));
        $cb->setChecked((bool) $this->settings->get('mail_notification_message', '0'));
        $a_form->addItem($cb);
    }

References ilPropertyFormGUI\addItem(), init(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilMailCronNotification::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilMailCronNotification::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilMailCronNotification::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 59 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 ilCronJob.

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

                           : string
    {
        return 'mail_notification';
    }

◆ getTitle()

ilMailCronNotification::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 52 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 ilCronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilMailCronNotification::hasCustomSettings ( )

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilMailCronNotification::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

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

                                         : bool
    {
        return false;
    }

◆ init()

ilMailCronNotification::init ( )

protected

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

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

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

Referenced by addCustomSettingsToForm(), getDescription(), getTitle(), and saveCustomSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilMailCronNotification::run ( )

Reimplemented from ilCronJob.

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

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

References ilCronJobResult\STATUS_OK.

◆ saveCustomSettings()

ilMailCronNotification::saveCustomSettings ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

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

                                                                 : bool
    {
        $this->init();
        $this->settings->set(
            'mail_notification_message',
            (string) ($this->http->wrapper()->post()->has('mail_notification_message') ? 1 : 0)
        );
        return true;
    }

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

Here is the call graph for this function:

Field Documentation

◆ $http

GlobalHttpState ilMailCronNotification::$http

private

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

◆ $initDone

bool ilMailCronNotification::$initDone = false

protected

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

◆ $lng

ilLanguage ilMailCronNotification::$lng

protected

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

◆ $settings

ilSetting ilMailCronNotification::$settings

protected

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

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

Services/Mail/classes/class.ilMailCronNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ init()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $http

◆ $initDone

◆ $lng

◆ $settings