Inheritance diagram for ilPrgUserRiskyToFailCronJob:

Collaboration diagram for ilPrgUserRiskyToFailCronJob:

Public Member Functions
	__construct ()

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. 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 ()

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

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

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. 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...

Data Fields
const	ID = 'prg_user_risky_to_fail'

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
	getNow ()

	getSettingsRepository ()

	getProgressRepository ()

	getEvents ()

	log (string $msg)

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

Protected Attributes
	$programme_settings_db

	$user_progress_db

	$events

	$dic

	$lng

Detailed Description

Definition at line 9 of file class.ilPrgUserRiskyToFailCronJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilPrgUserRiskyToFailCronJob::__construct ( )

Definition at line 38 of file class.ilPrgUserRiskyToFailCronJob.php.

References $DIC, ilStudyProgrammeDIC\dic(), and log().

     {
         global $DIC;
         $this->log = $DIC['ilLog'];
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule('prg');
 
         $this->dic = ilStudyProgrammeDIC::dic();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUserRiskyToFailCronJob::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Definition at line 103 of file class.ilPrgUserRiskyToFailCronJob.php.

     {
         return self::SCHEDULE_TYPE_IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgUserRiskyToFailCronJob::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Definition at line 113 of file class.ilPrgUserRiskyToFailCronJob.php.

     {
         return 1;
     }

◆ getDescription()

ilPrgUserRiskyToFailCronJob::getDescription ( )

Get description.

Returns: string

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

     {
         return $this->lng->txt('prg_user_risky_to_fail_desc');
     }

◆ getEvents()

ilPrgUserRiskyToFailCronJob::getEvents ( )

protected

Definition at line 176 of file class.ilPrgUserRiskyToFailCronJob.php.

Referenced by run().

     {
         return $this->dic['ilStudyProgrammeEvents'];
     }

Here is the caller graph for this function:

◆ getId()

ilPrgUserRiskyToFailCronJob::getId ( )

Get id.

Returns: string

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

     {
         return self::ID;
     }

◆ getNow()

ilPrgUserRiskyToFailCronJob::getNow ( )

protected

Definition at line 161 of file class.ilPrgUserRiskyToFailCronJob.php.

Referenced by run().

                                 : \DateTimeImmutable
     {
         return new DateTimeImmutable();
     }

Here is the caller graph for this function:

◆ getProgressRepository()

ilPrgUserRiskyToFailCronJob::getProgressRepository ( )

protected

Definition at line 171 of file class.ilPrgUserRiskyToFailCronJob.php.

Referenced by run().

                                                : ilStudyProgrammeProgressDBRepository
     {
         return $this->dic['ilStudyProgrammeUserProgressDB'];
     }

Here is the caller graph for this function:

◆ getSettingsRepository()

ilPrgUserRiskyToFailCronJob::getSettingsRepository ( )

protected

Definition at line 166 of file class.ilPrgUserRiskyToFailCronJob.php.

Referenced by run().

                                                : ilStudyProgrammeSettingsDBRepository
     {
         return $this->dic['model.Settings.ilStudyProgrammeSettingsRepository'];
     }

Here is the caller graph for this function:

◆ getTitle()

ilPrgUserRiskyToFailCronJob::getTitle ( )

Get title.

Returns: string

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

     {
         return $this->lng->txt('prg_user_risky_to_fail_title');
     }

◆ hasAutoActivation()

ilPrgUserRiskyToFailCronJob::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

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

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgUserRiskyToFailCronJob::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Definition at line 93 of file class.ilPrgUserRiskyToFailCronJob.php.

     {
         return true;
     }

◆ log()

ilPrgUserRiskyToFailCronJob::log ( string $msg )

protected

Definition at line 181 of file class.ilPrgUserRiskyToFailCronJob.php.

Referenced by __construct(), and run().

                                         : void
     {
         $this->log->write($msg);
     }

Here is the caller graph for this function:

◆ run()

ilPrgUserRiskyToFailCronJob::run ( )

Definition at line 118 of file class.ilPrgUserRiskyToFailCronJob.php.

References $events, $result, getEvents(), getNow(), getProgressRepository(), getSettingsRepository(), log(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

     {
         $result = new ilCronJobResult();
         $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
         $programmes_to_send = $this->getSettingsRepository()
             ->getProgrammeIdsWithRiskyToFailSettings();
 
         if (count($programmes_to_send) == 0) {
             return $result;
         }
 
         $today = $this->getNow();
         $programmes_and_due = [];
         foreach ($programmes_to_send as $programme_obj_id => $days_offset_mail) {
             $interval = new DateInterval('P' . $days_offset_mail . 'D');
             $due = $today->add($interval);
             $programmes_and_due[$programme_obj_id] = $due;
         }
 
         $progresses = $this->getProgressRepository()
             ->getRiskyToFail($programmes_and_due);
         
         if (count($progresses) == 0) {
             return $result;
         }
 
         $events = $this->getEvents();
         foreach ($progresses as $progress) {
             $this->log(
                 sprintf(
                     'PRG, RiskyToFail: user %s at progress %s (prg obj_id %s)',
                     $progress->getUserId(),
                     $progress->getId(),
                     $progress->getNodeId()
                 )
             );
             $events->userRiskyToFail($progress);
         }
         $result->setStatus(ilCronJobResult::STATUS_OK);
         return $result;
     }