ilConsultationHourCron Class Reference

Reminders for consultation hours. More...

Inheritance diagram for ilConsultationHourCron:

Collaboration diagram for ilConsultationHourCron:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	run ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
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 Attributes
ilLanguage	$lng
ilDBInterface	$db
ilSetting	$setting
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Reminders for consultation hours.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilConsultationHourCron::__construct

(

)

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

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

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('dateplaner');
        $this->db = $DIC->database();
        $this->setting = $DIC->settings();
    }

Here is the call graph for this function:

Member Function Documentation

addCustomSettingsToForm()

ilConsultationHourCron::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

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

                                                                      : void
    {
        $consultation_days = new ilNumberInputGUI($this->lng->txt('cal_ch_cron_reminder_days'), 'ch_reminder_days');
        $consultation_days->setMinValue(1);
        $consultation_days->setMaxLength(2);
        $consultation_days->setSize(2);
        $consultation_days->setValue((string) $this->setting->get('ch_reminder_days', '2'));
        $consultation_days->setRequired(true);
        $a_form->addItem($consultation_days);
    }

Here is the call graph for this function:

getDefaultScheduleType()

ilConsultationHourCron::getDefaultScheduleType

(

)

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

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilConsultationHourCron::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilConsultationHourCron::getDescription

(

)

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

References ILIAS\Repository\lng().

                                    : string
    {
        return $this->lng->txt("cal_ch_cron_reminder_info");
    }

Here is the call graph for this function:

getId()

ilConsultationHourCron::getId

(

)

Definition at line 43 of file class.ilConsultationHourCron.php.

                           : string
    {
        return "cal_consultation";
    }

getTitle()

ilConsultationHourCron::getTitle

(

)

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

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt("cal_ch_cron_reminder");
    }

Here is the call graph for this function:

hasAutoActivation()

ilConsultationHourCron::hasAutoActivation

(

)

Definition at line 68 of file class.ilConsultationHourCron.php.

                                       : bool
    {
        return false;
    }

hasCustomSettings()

ilConsultationHourCron::hasCustomSettings

(

)

Definition at line 78 of file class.ilConsultationHourCron.php.

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilConsultationHourCron::hasFlexibleSchedule

(

)

Definition at line 73 of file class.ilConsultationHourCron.php.

                                         : bool
    {
        return false;
    }

run()

ilConsultationHourCron::run

(

)

Definition at line 83 of file class.ilConsultationHourCron.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, IL_CAL_DAY, IL_CAL_UNIX, ILIAS\Repository\int(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, ilCalendarMailNotification\TYPE_BOOKING_REMINDER, and ilTimeZone\UTC.

                         : ilCronJobResult
    {
        $status = ilCronJobResult::STATUS_NO_ACTION;

        $days_before = (int) $this->setting->get('ch_reminder_days');
        $now = new ilDateTime(time(), IL_CAL_UNIX);
        $limit = clone $now;
        $limit->increment(IL_CAL_DAY, $days_before);

        $counter = 0;
        $query = 'SELECT * FROM booking_user ' .
            'JOIN cal_entries ON entry_id = cal_id ' .
            'WHERE notification_sent = ' . $this->db->quote(0, 'integer') . ' ' .
            'AND starta > ' . $this->db->quote($now->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), 'timestamp') . ' ' .
            'AND starta <= ' . $this->db->quote($limit->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), 'timestamp');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $mail = new ilCalendarMailNotification();
            $mail->setAppointmentId((int) $row->entry_id);
            $mail->setRecipients(array((int) $row->user_id));
            $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_REMINDER);
            $mail->send();

            // update notification
            $query = 'UPDATE booking_user ' .
                'SET notification_sent = ' . $this->db->quote(1, 'integer') . ' ' .
                'WHERE user_id = ' . $this->db->quote($row->user_id, 'integer') . ' ' .
                'AND entry_id = ' . $this->db->quote($row->entry_id, 'integer');
            $this->db->manipulate($query);
            $counter++;
        }

        if ($counter) {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }

Here is the call graph for this function:

saveCustomSettings()

ilConsultationHourCron::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

Definition at line 134 of file class.ilConsultationHourCron.php.

References ilPropertyFormGUI\getInput().

                                                                 : bool
    {
        $this->setting->set('ch_reminder_days', (string) $a_form->getInput('ch_reminder_days'));
        return true;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilConsultationHourCron::$db

protected

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

$lng

ilLanguage ilConsultationHourCron::$lng

protected

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

$setting

ilSetting ilConsultationHourCron::$setting

protected

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

---

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

• components/ILIAS/Calendar/classes/ConsultationHours/class.ilConsultationHourCron.php