ilExcCronReminders Class Reference

Cron for exercise reminders. More...

Inheritance diagram for ilExcCronReminders:

Collaboration diagram for ilExcCronReminders:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)
	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
	usesLegacyForms ()
	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
	saveCustomConfiguration (mixed $form_data)
	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
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Cron for exercise reminders.

Author

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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilExcCronReminders::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilExcCronReminders::getDefaultScheduleType

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

getDefaultScheduleValue()

ilExcCronReminders::getDefaultScheduleValue

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilExcCronReminders::getDescription

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

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

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

getId()

ilExcCronReminders::getId

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return "exc_reminders";
    }

getTitle()

ilExcCronReminders::getTitle

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

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

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

hasAutoActivation()

ilExcCronReminders::hasAutoActivation

(

)

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilExcCronReminders::hasFlexibleSchedule

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

run()

ilExcCronReminders::run

(

)

Exceptions

ilExcUnknownAssignmentTypeException

Reimplemented from ILIAS\Cron\CronJob.

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

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

References $log, $message, ilLoggerFactory\getLogger(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilExcCronReminders::$lng

protected

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

Referenced by getDescription(), and getTitle().

---

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

• components/ILIAS/Exercise/classes/class.ilExcCronReminders.php