ilExcCronReminders Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilExcCronReminders:

Collaboration diagram for ilExcCronReminders:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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
Protected Attributes inherited from ilCronJob
int	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 25 of file class.ilExcCronReminders.php.

Constructor & Destructor Documentation

__construct()

ilExcCronReminders::__construct

(

)

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilExcCronReminders::getDefaultScheduleType

(

)

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

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilExcCronReminders::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilExcCronReminders::getDescription

(

)

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

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

                                    : string
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("exc");

        return $lng->txt("exc_reminders_cron_info");
    }

Here is the call graph for this function:

getId()

ilExcCronReminders::getId

(

)

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

                           : string
    {
        return "exc_reminders";
    }

getTitle()

ilExcCronReminders::getTitle

(

)

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

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

                              : string
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("exc");

        return $lng->txt("exc_reminders_cron");
    }

Here is the call graph for this function:

hasAutoActivation()

ilExcCronReminders::hasAutoActivation

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilExcCronReminders::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

run()

ilExcCronReminders::run

(

)

Exceptions

ilExcUnknownAssignmentTypeException

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

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

                         : ilCronJobResult
    {
        $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 !== 0) {
            $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 . ' / ' . "#" . $num_reminders);
        }

        return $cron_result;
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilExcCronReminders::$lng

protected

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

Referenced by getDescription(), and getTitle().

---

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

• Modules/Exercise/classes/class.ilExcCronReminders.php