Cron for survey notifications (reminder to paricipate in the survey) More...

Inheritance diagram for ilSurveyCronNotification:

Collaboration diagram for ilSurveyCronNotification:

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

ilTree	$tree

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

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 27 of file class.ilSurveyCronNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyCronNotification::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilSurveyCronNotification::getDefaultScheduleType ( )

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

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilSurveyCronNotification::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilSurveyCronNotification::getDescription ( )

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

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

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

Here is the call graph for this function:

◆ getId()

ilSurveyCronNotification::getId ( )

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

                            : string
     {
         return "survey_notification";
     }

◆ getTitle()

ilSurveyCronNotification::getTitle ( )

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

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

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilSurveyCronNotification::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilSurveyCronNotification::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return false;
     }

◆ run()

ilSurveyCronNotification::run ( )

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

References $log, $message, $tree, ilLoggerFactory\getLogger(), ROOT_FOLDER_ID, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                          : 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;
     }