Delete orphaned mails. More...

Inheritance diagram for ilMailCronOrphanedMails:

Collaboration diagram for ilMailCronOrphanedMails:

Public Member Functions
	getId ()
	Get id. More...

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getValidScheduleTypes ()

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	run ()
	Run job. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

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

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

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Protected Member Functions
	init ()

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$lng

	$settings

	$db

	$user

	$initDone = false

Private Member Functions
	processNotification ()

	processDeletion ()

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Detailed Description

Delete orphaned mails.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 14 of file class.ilMailCronOrphanedMails.php.

Member Function Documentation

◆ addCustomSettingsToForm()

ilMailCronOrphanedMails::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Definition at line 148 of file class.ilMailCronOrphanedMails.php.

References $_POST, ilPropertyFormGUI\addItem(), init(), ilFormPropertyGUI\setInfo(), and settings().

     {
         $this->init();
         parent::addCustomSettingsToForm($a_form);
 
         $threshold = new ilNumberInputGUI($this->lng->txt('mail_threshold'), 'mail_threshold');
         $threshold->setInfo($this->lng->txt('mail_threshold_info'));
         $threshold->allowDecimals(false);
         $threshold->setSuffix($this->lng->txt('days'));
         $threshold->setMinValue(1);
         $threshold->setValue($this->settings->get('mail_threshold'));
 
         $a_form->addItem($threshold);
         
         $mail_folder = new ilCheckboxInputGUI($this->lng->txt('only_inbox_trash'), 'mail_only_inbox_trash');
         $mail_folder->setInfo($this->lng->txt('only_inbox_trash_info'));
         $mail_folder->setChecked($this->settings->get('mail_only_inbox_trash'));
         $a_form->addItem($mail_folder);
         
         $notification = new ilNumberInputGUI($this->lng->txt('mail_notify_orphaned'), 'mail_notify_orphaned');
         $notification->setInfo($this->lng->txt('mail_notify_orphaned_info'));
         $notification->allowDecimals(false);
         $notification->setSuffix($this->lng->txt('days'));
         $notification->setMinValue(0);
         
         $mail_threshold = isset($_POST['mail_threshold']) ? (int) $_POST['mail_threshold'] : $this->settings->get('mail_threshold');
         $maxvalue = $mail_threshold - 1;
         $notification->setMaxValue($maxvalue);
         $notification->setValue($this->settings->get('mail_notify_orphaned'));
         $a_form->addItem($notification);
     }

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilMailCronOrphanedMails::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Definition at line 123 of file class.ilMailCronOrphanedMails.php.

     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilMailCronOrphanedMails::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Definition at line 132 of file class.ilMailCronOrphanedMails.php.

     {
         return 1;
     }

◆ getDescription()

ilMailCronOrphanedMails::getDescription ( )

Returns: string

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

References init().

     {
         $this->init();
         return $this->lng->txt("mail_orphaned_mails_desc");
     }

Here is the call graph for this function:

◆ getId()

ilMailCronOrphanedMails::getId ( )

Get id.

Returns: string

Definition at line 63 of file class.ilMailCronOrphanedMails.php.

     {
         return "mail_orphaned_mails";
     }

◆ getTitle()

ilMailCronOrphanedMails::getTitle ( )

Returns: string

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

References init().

     {
         $this->init();
         return $this->lng->txt("mail_orphaned_mails");
     }

Here is the call graph for this function:

◆ getValidScheduleTypes()

ilMailCronOrphanedMails::getValidScheduleTypes ( )

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

     {
         return array(
             self::SCHEDULE_TYPE_DAILY,
             self::SCHEDULE_TYPE_WEEKLY,
             self::SCHEDULE_TYPE_MONTHLY,
             self::SCHEDULE_TYPE_QUARTERLY,
             self::SCHEDULE_TYPE_YEARLY,
             self::SCHEDULE_TYPE_IN_DAYS
         );
     }

◆ hasAutoActivation()

ilMailCronOrphanedMails::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

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

     {
         return false;
     }

◆ hasCustomSettings()

ilMailCronOrphanedMails::hasCustomSettings ( )

Returns: bool

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

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilMailCronOrphanedMails::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Definition at line 99 of file class.ilMailCronOrphanedMails.php.

     {
         return true;
     }

◆ init()

ilMailCronOrphanedMails::init ( )

protected

Definition at line 44 of file class.ilMailCronOrphanedMails.php.

References $DIC, settings(), and user().

Referenced by addCustomSettingsToForm(), getDescription(), getTitle(), processDeletion(), processNotification(), run(), and saveCustomSettings().

     {
         global $DIC;
 
         if (!$this->initDone) {
             $this->settings = $DIC->settings();
             $this->lng = $DIC->language();
             $this->db = $DIC->database();
             $this->user = $DIC->user();
 
             $this->lng->loadLanguageModule('mail');
             $this->initDone = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processDeletion()

ilMailCronOrphanedMails::processDeletion ( )

private

Definition at line 254 of file class.ilMailCronOrphanedMails.php.

References init().

Referenced by run().

     {
         $this->init();
         include_once './Services/Mail/classes/class.ilMailCronOrphanedMailsDeletionCollector.php';
         $collector = new ilMailCronOrphanedMailsDeletionCollector();
 
         include_once './Services/Mail/classes/class.ilMailCronOrphanedMailsDeletionProcessor.php';
         $processor = new ilMailCronOrphanedMailsDeletionProcessor($collector);
         $processor->processDeletion();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processNotification()

ilMailCronOrphanedMails::processNotification ( )

private

Definition at line 239 of file class.ilMailCronOrphanedMails.php.

References init(), ilMailCronOrphanedMailsNotifier\processNotification(), and settings().

Referenced by run().

     {
         $this->init();
         include_once './Services/Mail/classes/class.ilMailCronOrphanedMailsNotificationCollector.php';
         $collector = new ilMailCronOrphanedMailsNotificationCollector();
 
         include_once'./Services/Mail/classes/class.ilMailCronOrphanedMailsNotifier.php';
         $notifier = new ilMailCronOrphanedMailsNotifier(
             $collector,
             (int) $this->settings->get('mail_threshold'),
             (int) $this->settings->get('mail_notify_orphaned')
         );
         $notifier->processNotification();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilMailCronOrphanedMails::run ( )

Run job.

Returns: ilCronJobResult

Definition at line 209 of file class.ilMailCronOrphanedMails.php.

References $result, ilLoggerFactory\getLogger(), init(), processDeletion(), processNotification(), settings(), and ilCronJobResult\STATUS_OK.

     {
         $this->init();
         $mail_threshold = (int) $this->settings->get('mail_threshold');
 
         ilLoggerFactory::getLogger('mail')->info(sprintf(
             'Started mail deletion job with threshold: %s day(s)',
             var_export($mail_threshold, 1)
         ));
 
         if ((int) $this->settings->get('mail_notify_orphaned') >= 1 && $mail_threshold >= 1) {
             $this->processNotification();
         }
 
         if ((int) $this->settings->get('last_cronjob_start_ts', time()) && $mail_threshold >= 1) {
             $this->processDeletion();
         }
 
         $result = new ilCronJobResult();
         $status = ilCronJobResult::STATUS_OK;
         $result->setStatus($status);
 
         ilLoggerFactory::getLogger('mail')->info(sprintf(
             'Finished mail deletion job with threshold: %s day(s)',
             var_export($mail_threshold, 1)
         ));
 
         return $result;
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilMailCronOrphanedMails::saveCustomSettings ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Returns: bool

Definition at line 184 of file class.ilMailCronOrphanedMails.php.

References ilPropertyFormGUI\getInput(), ilLoggerFactory\getLogger(), init(), settings(), and user().

     {
         $this->init();
         $this->settings->set('mail_threshold', (int) $a_form->getInput('mail_threshold'));
         $this->settings->set('mail_only_inbox_trash', (int) $a_form->getInput('mail_only_inbox_trash'));
         $this->settings->set('mail_notify_orphaned', (int) $a_form->getInput('mail_notify_orphaned'));
 
         if ($this->settings->get('mail_notify_orphaned') == 0) {
             //delete all mail_cron_orphaned-table entries!
             $this->db->manipulate('DELETE FROM mail_cron_orphaned');
 
             ilLoggerFactory::getLogger('mail')->info(sprintf(
                 "Deleted all scheduled mail deletions because a reminder should't be sent (login: %s|usr_id: %s) anymore!",
                 $this->user->getLogin(),
                 $this->user->getId()
             ));
         }
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilMailCronOrphanedMails::$db

protected

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

◆ $initDone

ilMailCronOrphanedMails::$initDone = false

protected

Definition at line 39 of file class.ilMailCronOrphanedMails.php.

◆ $lng

ilMailCronOrphanedMails::$lng

protected

Definition at line 19 of file class.ilMailCronOrphanedMails.php.

◆ $settings

ilMailCronOrphanedMails::$settings

protected

Definition at line 24 of file class.ilMailCronOrphanedMails.php.

◆ $user

ilMailCronOrphanedMails::$user

protected

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

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

Services/Mail/classes/class.ilMailCronOrphanedMails.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomSettingsToForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ init()

◆ processDeletion()

◆ processNotification()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $db

◆ $initDone

◆ $lng

◆ $settings

◆ $user