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

Inheritance diagram for ilPrgUserRiskyToFailCronJob:

Collaboration diagram for ilPrgUserRiskyToFailCronJob:

Public Member Functions
	__construct ()

	getTitle ()

	getDescription ()

	getId ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

	log (string $msg)

Protected Attributes
ilComponentLogger	$log

ilLanguage	$lng

ilPRGAssignmentDBRepository	$assignment_repo

ilPrgCronJobAdapter	$adapter

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
const	ID = 'prg_user_risky_to_fail'

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

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgUserRiskyToFailCronJob::__construct ( )

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

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

     {
         global $DIC;
         $this->log = $DIC['ilLog'];
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule('prg');
 
         $dic = ilStudyProgrammeDIC::dic();
         $this->assignment_repo = $dic['repo.assignment'];
         $this->adapter = $dic['cron.riskyToFail'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUserRiskyToFailCronJob::getDefaultScheduleType ( )

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

                                             : JobScheduleType
     {
         return JobScheduleType::IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgUserRiskyToFailCronJob::getDefaultScheduleValue ( )

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

◆ getDescription()

ilPrgUserRiskyToFailCronJob::getDescription ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilPrgUserRiskyToFailCronJob::getId ( )

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

                            : string
     {
         return self::ID;
     }

◆ getNow()

ilPrgUserRiskyToFailCronJob::getNow ( )

protected

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

Referenced by run().

                                : \DateTimeImmutable
     {
         return new DateTimeImmutable();
     }

Here is the caller graph for this function:

◆ getTitle()

ilPrgUserRiskyToFailCronJob::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUserRiskyToFailCronJob::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgUserRiskyToFailCronJob::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ log()

ilPrgUserRiskyToFailCronJob::log ( string $msg )

protected

Definition at line 130 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 81 of file class.ilPrgUserRiskyToFailCronJob.php.

References getNow(), and log().

Referenced by ilStudyProgrammeCronRiskyToFailTest\testRiskyToFailEvents().

                          : JobResult
     {
         $result = new JobResult();
         $result->setStatus(JobResult::STATUS_NO_ACTION);
 
         $programmes_to_send = $this->adapter->getRelevantProgrammeIds();
         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;
         }
 
 
         //root-assignments for any node that has deadline = $due and was not sent before;
         $assignments = $this->assignment_repo->getRiskyToFail($programmes_and_due, true);
 
         if (count($assignments) == 0) {
             return $result;
         }
 
         foreach ($assignments as $ass) {
             $pgs = $ass->getProgressTree();
             $this->log(
                 sprintf(
                     'PRG, RiskyToFail: user %s at progress %s (prg obj_id %s)',
                     $ass->getUserId(),
                     $ass->getId(),
                     $pgs->getNodeId()
                 )
             );
 
             $this->adapter->actOnSingleAssignment($ass);
             $this->assignment_repo->storeRiskyToFailSentFor($ass);
         }
         $result->setStatus(JobResult::STATUS_OK);
         return $result;
     }