Inheritance diagram for ilPrgInvalidateExpiredProgressesCronJob:

Collaboration diagram for ilPrgInvalidateExpiredProgressesCronJob:

Public Member Functions
	__construct ()

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	ID = 'prg_invalidate_expired_progresses'

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Attributes
	$user_progress_db

	$log

	$lng

Additional Inherited Members
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgInvalidateExpiredProgressesCronJob::__construct ( )

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

References $DIC, and ilStudyProgrammeDIC\dic().

     {
         global $DIC;
 
         $this->user_progress_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
         $this->log = $DIC['ilLog'];
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule('prg');
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgInvalidateExpiredProgressesCronJob::getDefaultScheduleType ( )

Get schedule type.

Returns: int

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

     {
         return self::SCHEDULE_TYPE_IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgInvalidateExpiredProgressesCronJob::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

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

     {
         return 1;
     }

◆ getDescription()

ilPrgInvalidateExpiredProgressesCronJob::getDescription ( )

Get description.

Returns: string

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

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

◆ getId()

ilPrgInvalidateExpiredProgressesCronJob::getId ( )

Get id.

Returns: string

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

     {
         return self::ID;
     }

◆ getTitle()

ilPrgInvalidateExpiredProgressesCronJob::getTitle ( )

Get title.

Returns: string

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

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

◆ hasAutoActivation()

ilPrgInvalidateExpiredProgressesCronJob::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

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

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgInvalidateExpiredProgressesCronJob::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

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

     {
         return true;
     }

◆ run()

ilPrgInvalidateExpiredProgressesCronJob::run ( )

Run job.

Returns: ilCronJobResult

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

References Vendor\Package\$e, $result, and ilCronJobResult\STATUS_OK.

     {
         $result = new ilCronJobResult();
         foreach ($this->user_progress_db->getExpiredSuccessfulInstances() as $progress) {
             try {
                 $progress->invalidate();
             } catch (ilException $e) {
                 $this->log->write('an error occured: ' . $e->getMessage());
             }
         }
         $result->setStatus(ilCronJobResult::STATUS_OK);
         return $result;
     }