Cron for exercise reminders. More...

Inheritance diagram for ilExcCronReminders:

Collaboration diagram for ilExcCronReminders:

Public Member Functions
	__construct ()
	Constructor. More...

	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

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

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

	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 Attributes
	$lng

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

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

Detailed Description

Cron for exercise reminders.

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 13 of file class.ilExcCronReminders.php.

Constructor & Destructor Documentation

◆ __construct()

ilExcCronReminders::__construct ( )

Constructor.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
    }

References $DIC.

Member Function Documentation

◆ getDefaultScheduleType()

ilExcCronReminders::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

Definition at line 54 of file class.ilExcCronReminders.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilExcCronReminders::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

Definition at line 59 of file class.ilExcCronReminders.php.

    {
        return;
    }

◆ getDescription()

ilExcCronReminders::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

Definition at line 45 of file class.ilExcCronReminders.php.

    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("exc");
 
        return $lng->txt("exc_reminders_cron_info");
    }

References $lng.

◆ getId()

ilExcCronReminders::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return "exc_reminders";
    }

◆ getTitle()

ilExcCronReminders::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

Definition at line 36 of file class.ilExcCronReminders.php.

    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("exc");
 
        return $lng->txt("exc_reminders_cron");
    }

References $lng.

◆ hasAutoActivation()

ilExcCronReminders::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

Definition at line 64 of file class.ilExcCronReminders.php.

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilExcCronReminders::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

Definition at line 69 of file class.ilExcCronReminders.php.

    {
        return true;
    }

◆ run()

ilExcCronReminders::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

Definition at line 74 of file class.ilExcCronReminders.php.

    {
        include_once "Modules/Exercise/classes/class.ilExAssignmentReminder.php";
 
        $log = ilLoggerFactory::getLogger("exc");
        $log->debug("--- Start Exercise Reminders Cron");
 
        $cron_status = ilCronJobResult::STATUS_NO_ACTION;
        $message = "";
        $reminder = new ilExAssignmentReminder();
        $num_reminders = $reminder->checkReminders();
 
        $this->lng->loadLanguageModule("exc");
 
        if ($num_reminders) {
            $cron_status = ilCronJobResult::STATUS_OK;
            $message = $this->lng->txt('exc_reminder_cron_ok');
        }
 
        $cron_result = new ilCronJobResult();
        $cron_result->setStatus($cron_status);
 
        if ($message != "") {
            $cron_result->setMessage($message . " " . $num_reminders);
            $cron_result->setCode("#" . $num_reminders);
        }
 
        return $cron_result;
    }