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

Inheritance diagram for ilSurveyCronNotification:

Collaboration diagram for ilSurveyCronNotification:

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 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

ilTree	$tree

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
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated 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 survey notifications (reminder to paricipate in the survey)

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 25 of file class.ilSurveyCronNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyCronNotification::__construct ( )

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        if (isset($DIC["tree"])) {
            $this->tree = $DIC->repositoryTree();
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilSurveyCronNotification::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilSurveyCronNotification::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilSurveyCronNotification::getDescription ( )

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

◆ getId()

ilSurveyCronNotification::getId ( )

Reimplemented from ilCronJob.

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

                           : string
    {
        return "survey_notification";
    }

◆ getTitle()

ilSurveyCronNotification::getTitle ( )

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilSurveyCronNotification::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilSurveyCronNotification::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

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

                                         : bool
    {
        return false;
    }

◆ run()

ilSurveyCronNotification::run ( )

Reimplemented from ilCronJob.

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

                         : ilCronJobResult
    {
        global $tree;
 
        $log = ilLoggerFactory::getLogger("svy");
        $log->debug("start");
 
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $message = array();
 
        $root = $tree->getNodeData(ROOT_FOLDER_ID);
        foreach ($tree->getSubTree($root, false, ["svy"]) as $svy_ref_id) {
            $svy = new ilObjSurvey($svy_ref_id);
            $num = $svy->checkReminder();
            if (!is_null($num)) {
                $message[] = $svy_ref_id . "(" . $num . ")";
                $status = ilCronJobResult::STATUS_OK;
            }
        }
 
        $result = new ilCronJobResult();
        $result->setStatus($status);
 
        if (count($message)) {
            $result->setMessage("Ref-Ids: " . implode(", ", $message) . ' / ' . "#" . count($message));
        }
        $log->debug("end");
        return $result;
    }