Inheritance diagram for ilMailCronNotification:

Collaboration diagram for ilMailCronNotification:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

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

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

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
GlobalHttpState	$http

Detailed Description

Mail notifications.

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

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

Member Function Documentation

◆ activationWasToggled()

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

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

References ilSetting\set().

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

Here is the call graph for this function:

◆ addCustomSettingsToForm()

ilMailCronNotification::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

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

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

                                                                       : 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);
     }

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilMailCronNotification::getDefaultScheduleType ( )

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

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilMailCronNotification::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilMailCronNotification::getDescription ( )

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

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

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

Here is the call graph for this function:

◆ getId()

ilMailCronNotification::getId ( )

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

                            : string
     {
         return 'mail_notification';
     }

◆ getTitle()

ilMailCronNotification::getTitle ( )

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

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

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilMailCronNotification::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilMailCronNotification::hasCustomSettings ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilMailCronNotification::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return false;
     }

◆ init()

ilMailCronNotification::init ( )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilMailCronNotification::run ( )

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

References ilCronJobResult\STATUS_OK.

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

◆ saveCustomSettings()

ilMailCronNotification::saveCustomSettings ( ilPropertyFormGUI $a_form )

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $http

GlobalHttpState ilMailCronNotification::$http

private

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

◆ $initDone

bool ilMailCronNotification::$initDone = false

protected

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

◆ $lng

ilLanguage ilMailCronNotification::$lng

protected

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

◆ $settings

ilSetting ilMailCronNotification::$settings

protected

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

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ init()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $http

◆ $initDone

◆ $lng

◆ $settings