Inheritance diagram for ilPrgInvalidateExpiredProgressesCronJob:

Collaboration diagram for ilPrgInvalidateExpiredProgressesCronJob:

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 Attributes
ilComponentLogger	$log

ilLanguage	$lng

ilPRGAssignmentDBRepository	$assignment_repo

ilStudyProgrammeSettingsDBRepository	$settings_repo

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_invalidate_expired_progresses'

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgInvalidateExpiredProgressesCronJob::__construct ( )

Definition at line 41 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

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

     {
         global $DIC;
         $this->log = $DIC['ilLog'];
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule('prg');
 
         $dic = ilStudyProgrammeDIC::dic();
         $this->assignment_repo = $dic['repo.assignment'];
         $this->settings_repo = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgInvalidateExpiredProgressesCronJob::getDefaultScheduleType ( )

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

                                             : JobScheduleType
     {
         return JobScheduleType::IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgInvalidateExpiredProgressesCronJob::getDefaultScheduleValue ( )

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

◆ getDescription()

ilPrgInvalidateExpiredProgressesCronJob::getDescription ( )

Definition at line 58 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilPrgInvalidateExpiredProgressesCronJob::getId ( )

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

                            : string
     {
         return self::ID;
     }

◆ getTitle()

ilPrgInvalidateExpiredProgressesCronJob::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgInvalidateExpiredProgressesCronJob::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgInvalidateExpiredProgressesCronJob::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilPrgInvalidateExpiredProgressesCronJob::run ( )

Definition at line 88 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

References Vendor\Package\$e.

                          : JobResult
     {
         $result = new JobResult();
         $expired = $this->assignment_repo->getExpiredAndNotInvalidated();
 
         if ($expired === []) {
             $result->setStatus(JobResult::STATUS_NO_ACTION);
             return $result;
         }
 
         foreach ($expired as $assignment) {
             try {
                 $assignment = $assignment->invalidate($this->settings_repo);
                 $this->assignment_repo->store($assignment);
             } catch (ilException $e) {
                 $this->log->write('an error occured: ' . $e->getMessage());
                 $result->setStatus(JobResult::STATUS_FAIL);
                 return $result;
             }
         }
 
         $result->setStatus(JobResult::STATUS_OK);
         return $result;
     }