Cron for survey notifications. More...

Inheritance diagram for ilSurveyCronNotification:

Collaboration diagram for ilSurveyCronNotification:

Public Member Functions
	__construct ()
	Constructor. More...

	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	run ()
	Run job. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...

	getValidScheduleTypes ()
	Get all available schedule types. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Protected Attributes
	$lng

	$tree

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

Cron for survey notifications.

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

Constructor & Destructor Documentation

◆ __construct()

ilSurveyCronNotification::__construct ( )

Constructor.

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

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

References $DIC.

Member Function Documentation

◆ getDefaultScheduleType()

ilSurveyCronNotification::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilSurveyCronNotification::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

◆ getDescription()

ilSurveyCronNotification::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

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

References $lng.

◆ getId()

ilSurveyCronNotification::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return "survey_notification";
    }

◆ getTitle()

ilSurveyCronNotification::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

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

References $lng.

◆ hasAutoActivation()

ilSurveyCronNotification::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilSurveyCronNotification::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ run()

ilSurveyCronNotification::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        $tree = $this->tree;
        
        include_once "Modules/Survey/classes/class.ilObjSurvey.php";
        
        $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 ($num !== false) {
                $message[] = $svy_ref_id . "(" . $num . ")";
                $status = ilCronJobResult::STATUS_OK;
            }
        }
        
        $result = new ilCronJobResult();
        $result->setStatus($status);
        
        if (sizeof($message)) {
            $result->setMessage("Ref-Ids: " . implode(", ", $message));
            $result->setCode("#" . sizeof($message));
        }
        
        return $result;
    }