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 ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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 ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	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 ilCronJob
CronJobScheduleType	$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 30 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilPrgInvalidateExpiredProgressesCronJob::__construct ( )

Definition at line 39 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 76 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgInvalidateExpiredProgressesCronJob::getDefaultScheduleValue ( )

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

◆ getDescription()

ilPrgInvalidateExpiredProgressesCronJob::getDescription ( )

Definition at line 56 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 61 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

                            : string
     {
         return self::ID;
     }

◆ getTitle()

ilPrgInvalidateExpiredProgressesCronJob::getTitle ( )

Definition at line 51 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 66 of file class.ilPrgInvalidateExpiredProgressesCronJob.php.

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgInvalidateExpiredProgressesCronJob::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilPrgInvalidateExpiredProgressesCronJob::run ( )

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

References Vendor\Package\$e, ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                          : ilCronJobResult
     {
         $result = new ilCronJobResult();
         $expired = $this->assignment_repo->getExpiredAndNotInvalidated();
 
         if ($expired === []) {
             $result->setStatus(ilCronJobResult::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(ilCronJobResult::STATUS_FAIL);
                 return $result;
             }
         }
 
         $result->setStatus(ilCronJobResult::STATUS_OK);
         return $result;
     }