ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilPrgUpdateProgressCronJob Class Reference

This will set progresses to FAILED, if they are past the deadline (and not successful, yet) More...

+ Inheritance diagram for ilPrgUpdateProgressCronJob:
+ Collaboration diagram for ilPrgUpdateProgressCronJob:

Public Member Functions

 __construct ()
 
 getTitle ()
 
 getDescription ()
 
 getId ()
 
 hasAutoActivation ()
 Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
 
 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

Pimple Container $dic
 
ilLanguage $lng
 
ilStudyProgrammeSettingsDBRepository $settings_repo
 
ilPRGAssignmentDBRepository $assignment_repo
 
int $acting_user_id
 
- 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_update_progress'
 

Detailed Description

This will set progresses to FAILED, if they are past the deadline (and not successful, yet)

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgUpdateProgressCronJob::__construct ( )

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

40 {
41 global $DIC;
42 $this->lng = $DIC['lng'];
43 $this->lng->loadLanguageModule('prg');
44
46 $this->settings_repo = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
47 $this->assignment_repo = $dic['repo.assignment'];
48 $this->acting_user_id = $dic['current_user']->getId();
49 }
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUpdateProgressCronJob::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

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

77 {
78 return JobScheduleType::IN_DAYS;
79 }

◆ getDefaultScheduleValue()

ilPrgUpdateProgressCronJob::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

81 : ?int
82 {
83 return 1;
84 }

◆ getDescription()

ilPrgUpdateProgressCronJob::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

56 : string
57 {
58 return $this->lng->txt('prg_update_progress_description');
59 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getId()

ilPrgUpdateProgressCronJob::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

61 : string
62 {
63 return self::ID;
64 }

References ID.

◆ getTitle()

ilPrgUpdateProgressCronJob::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

51 : string
52 {
53 return $this->lng->txt('prg_update_progress_title');
54 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUpdateProgressCronJob::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

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

66 : bool
67 {
68 return true;
69 }

◆ hasFlexibleSchedule()

ilPrgUpdateProgressCronJob::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

71 : bool
72 {
73 return true;
74 }

◆ run()

ilPrgUpdateProgressCronJob::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

86 : JobResult
87 {
88 $result = new JobResult();
89 $result->setStatus(JobResult::STATUS_NO_ACTION);
90
91 $now = new DateTimeImmutable();
92
93 foreach ($this->assignment_repo->getPassedDeadline($now) as $assignment) {
94 $assignment = $assignment->markProgressesFailedForExpiredDeadline(
95 $this->settings_repo,
96 $this->acting_user_id
97 );
98 $this->assignment_repo->store($assignment);
99 }
100
101 $result->setStatus(JobResult::STATUS_OK);
102 return $result;
103 }

Field Documentation

◆ $acting_user_id

int ilPrgUpdateProgressCronJob::$acting_user_id
protected

Definition at line 37 of file class.ilPrgUpdateProgressCronJob.php.

◆ $assignment_repo

ilPRGAssignmentDBRepository ilPrgUpdateProgressCronJob::$assignment_repo
protected

Definition at line 36 of file class.ilPrgUpdateProgressCronJob.php.

◆ $dic

Pimple Container ilPrgUpdateProgressCronJob::$dic
protected

Definition at line 33 of file class.ilPrgUpdateProgressCronJob.php.

Referenced by __construct().

◆ $lng

ilLanguage ilPrgUpdateProgressCronJob::$lng
protected

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

◆ $settings_repo

ilStudyProgrammeSettingsDBRepository ilPrgUpdateProgressCronJob::$settings_repo
protected

Definition at line 35 of file class.ilPrgUpdateProgressCronJob.php.

◆ ID

const ilPrgUpdateProgressCronJob::ID = 'prg_update_progress'
private

Definition at line 31 of file class.ilPrgUpdateProgressCronJob.php.

Referenced by getId().


The documentation for this class was generated from the following file: