ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilPrgUpdateProgressCronJob Class Reference

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

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

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, ?int $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 (?int $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

Pimple Container $dic
 
ilLanguage $lng
 
ilStudyProgrammeSettingsDBRepository $settings_repo
 
ilPRGAssignmentDBRepository $assignment_repo
 
int $acting_user_id
 
- Protected Attributes inherited from ilCronJob
int $schedule_type = null
 
int $schedule_value = null
 
Closure $date_time_provider = null
 

Private Attributes

const ID = 'prg_update_progress'
 

Additional Inherited Members

- Data Fields inherited from ilCronJob
const SCHEDULE_TYPE_DAILY = 1
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_IN_MINUTES = 2
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_IN_HOURS = 3
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_IN_DAYS = 4
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_WEEKLY = 5
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_MONTHLY = 6
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_QUARTERLY = 7
 This will be replaced with an ENUM in ILIAS 9 More...
 
const SCHEDULE_TYPE_YEARLY = 8
 This will be replaced with an ENUM in ILIAS 9 More...
 

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 This will set progresses to FAILED, if they are past the deadline (and not successful, yet)

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgUpdateProgressCronJob::__construct ( )

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

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

36  {
37  global $DIC;
38  $this->lng = $DIC['lng'];
39  $this->lng->loadLanguageModule('prg');
40 
42  $this->settings_repo = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
43  $this->assignment_repo = $dic['repo.assignment'];
44  $this->acting_user_id = $dic['current_user']->getId();
45  }
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUpdateProgressCronJob::getDefaultScheduleType ( )

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

72  : int
73  {
74  return self::SCHEDULE_TYPE_IN_DAYS;
75  }

◆ getDefaultScheduleValue()

ilPrgUpdateProgressCronJob::getDefaultScheduleValue ( )

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

77  : ?int
78  {
79  return 1;
80  }

◆ getDescription()

ilPrgUpdateProgressCronJob::getDescription ( )

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

References ILIAS\Repository\lng().

52  : string
53  {
54  return $this->lng->txt('prg_update_progress_description');
55  }
+ Here is the call graph for this function:

◆ getId()

ilPrgUpdateProgressCronJob::getId ( )

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

57  : string
58  {
59  return self::ID;
60  }

◆ getTitle()

ilPrgUpdateProgressCronJob::getTitle ( )

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

References ILIAS\Repository\lng().

47  : string
48  {
49  return $this->lng->txt('prg_update_progress_title');
50  }
+ Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUpdateProgressCronJob::hasAutoActivation ( )

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

62  : bool
63  {
64  return true;
65  }

◆ hasFlexibleSchedule()

ilPrgUpdateProgressCronJob::hasFlexibleSchedule ( )

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

67  : bool
68  {
69  return true;
70  }

◆ run()

ilPrgUpdateProgressCronJob::run ( )

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

References ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

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

Field Documentation

◆ $acting_user_id

int ilPrgUpdateProgressCronJob::$acting_user_id
protected

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

◆ $assignment_repo

ilPRGAssignmentDBRepository ilPrgUpdateProgressCronJob::$assignment_repo
protected

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

◆ $dic

Pimple Container ilPrgUpdateProgressCronJob::$dic
protected

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

◆ $lng

ilLanguage ilPrgUpdateProgressCronJob::$lng
protected

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

◆ $settings_repo

ilStudyProgrammeSettingsDBRepository ilPrgUpdateProgressCronJob::$settings_repo
protected

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

◆ ID

const ilPrgUpdateProgressCronJob::ID = 'prg_update_progress'
private

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


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