ilMailCronNotification Class Reference

Mail notifications. More...

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

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

Mail notifications.

Author

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

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

Member Function Documentation

activationWasToggled()

ilMailCronNotification::activationWasToggled

(

$a_currently_active

)

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

References init(), and settings().

    {
        $this->init();
        $this->settings->set('mail_notification', (bool) $a_currently_active);
    }

Here is the call graph for this function:

addCustomSettingsToForm()

ilMailCronNotification::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

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

    {
        $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($this->settings->get("mail_notification_message"));
        $a_form->addItem($cb);
    }

Here is the call graph for this function:

getDefaultScheduleType()

ilMailCronNotification::getDefaultScheduleType

(

)

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilMailCronNotification::getDefaultScheduleValue

(

)

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

    {
        return;
    }

getDescription()

ilMailCronNotification::getDescription

(

)

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

References init().

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

Here is the call graph for this function:

getId()

ilMailCronNotification::getId

(

)

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

    {
        return "mail_notification";
    }

getTitle()

ilMailCronNotification::getTitle

(

)

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

References init().

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

Here is the call graph for this function:

hasAutoActivation()

ilMailCronNotification::hasAutoActivation

(

)

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

    {
        return false;
    }

hasCustomSettings()

ilMailCronNotification::hasCustomSettings

(

)

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

    {
        return true;
    }

hasFlexibleSchedule()

ilMailCronNotification::hasFlexibleSchedule

(

)

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

    {
        return false;
    }

init()

ilMailCronNotification::init ( )

protected

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

References $DIC, and settings().

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

    {
        global $DIC;

        if (!$this->initDone) {
            $this->settings = $DIC->settings();
            $this->lng = $DIC->language();

            $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 86 of file class.ilMailCronNotification.php.

References $result, and ilCronJobResult\STATUS_OK.

    {
        require_once 'Services/Mail/classes/class.ilMailSummaryNotification.php';
        $msn = new ilMailSummaryNotification();
        $msn->send();

        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

saveCustomSettings()

ilMailCronNotification::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

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

References $_POST, init(), and settings().

    {
        $this->init();
        $this->settings->set('mail_notification_message', $_POST['mail_notification_message'] ? 1 : 0);
        return true;
    }

Here is the call graph for this function:

Field Documentation

$initDone

ilMailCronNotification::$initDone = false

protected

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

$lng

ilMailCronNotification::$lng

protected

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

$settings

ilMailCronNotification::$settings

protected

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

---

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

• Services/Mail/classes/class.ilMailCronNotification.php