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 ()
	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
const	MAX_MESSAGE_LENGTH = 397

ilLanguage	$lng

ilTree	$tree

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$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 29 of file class.ilSurveyCronNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyCronNotification::__construct ( )

Definition at line 36 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 ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilSurveyCronNotification::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilSurveyCronNotification::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 59 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 ILIAS\Cron\CronJob.

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

                           : string
    {
        return "survey_notification";
    }

◆ getTitle()

ilSurveyCronNotification::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 51 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 ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilSurveyCronNotification::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return false;
    }

◆ run()

ilSurveyCronNotification::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        global $tree;
 
        $log = ilLoggerFactory::getLogger("svy");
        $log->debug("start");
 
        $status = JobResult::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 = JobResult::STATUS_OK;
            }
        }
 
        $result = new JobResult();
        $result->setStatus($status);
 
        if (count($message)) {
            $full_msg = "Ref-Ids: " . implode(", ", $message) . ' / ' . "#" . count($message);
 
            if (mb_strlen($full_msg) > self::MAX_MESSAGE_LENGTH) {
                $short_msg = mb_substr($full_msg, 0, self::MAX_MESSAGE_LENGTH) . '...';
                $log->info("Notification message was truncated to fit DB limit. Full message: \"$full_msg\"");
            } else {
                $short_msg = $full_msg;
            }
 
            $result->setMessage($short_msg);
        }
 
        $log->debug("end");
        return $result;
    }