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 ()

	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
Pimple Container	$dic

ilLanguage	$lng

ilStudyProgrammeSettingsDBRepository	$settings_repo

ilPRGAssignmentDBRepository	$assignment_repo

int	$acting_user_id

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$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 27 of file class.ilPrgUpdateProgressCronJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilPrgUpdateProgressCronJob::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUpdateProgressCronJob::getDefaultScheduleType ( )

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

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgUpdateProgressCronJob::getDefaultScheduleValue ( )

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

◆ getDescription()

ilPrgUpdateProgressCronJob::getDescription ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilPrgUpdateProgressCronJob::getId ( )

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

                            : string
     {
         return self::ID;
     }

◆ getTitle()

ilPrgUpdateProgressCronJob::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUpdateProgressCronJob::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgUpdateProgressCronJob::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilPrgUpdateProgressCronJob::run ( )

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

References ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                          : ilCronJobResult
     {
         $result = new ilCronJobResult();
         $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
         $now = new DateTimeImmutable();
 
         foreach ($this->assignment_repo->getPassedDeadline($now) as $assignment) {
             $assignment = $assignment->markProgressesFailedForExpiredDeadline(
                 $this->settings_repo,
                 $this->acting_user_id
             );
             $this->assignment_repo->store($assignment);
         }
 
         $result->setStatus(ilCronJobResult::STATUS_OK);
         return $result;
     }

Field Documentation

◆ $acting_user_id

int ilPrgUpdateProgressCronJob::$acting_user_id

protected

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

◆ $assignment_repo

ilPRGAssignmentDBRepository ilPrgUpdateProgressCronJob::$assignment_repo

protected

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

◆ $dic

Pimple Container ilPrgUpdateProgressCronJob::$dic

protected

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

◆ $lng

ilLanguage ilPrgUpdateProgressCronJob::$lng

protected

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

◆ $settings_repo

ilStudyProgrammeSettingsDBRepository ilPrgUpdateProgressCronJob::$settings_repo

protected

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

◆ ID

const ilPrgUpdateProgressCronJob::ID = 'prg_update_progress'

private

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

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

components/ILIAS/StudyProgramme/classes/class.ilPrgUpdateProgressCronJob.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ run()

Field Documentation

◆ $acting_user_id

◆ $assignment_repo

◆ $dic

◆ $lng

◆ $settings_repo

◆ ID