Inheritance diagram for ilCronJob:

Collaboration diagram for ilCronJob:

Public Member Functions
	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
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Member Functions
	checkWeeklySchedule (DateTimeImmutable $last_run, DateTimeImmutable $now)

	checkSchedule (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value)

Detailed Description

Definition at line 23 of file class.ilCronJob.php.

Member Function Documentation

◆ activationWasToggled()

ilCronJob::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.

Furthermore only few dependencies may be available in the $DIC.

Definition at line 268 of file class.ilCronJob.php.

References getDefaultScheduleType(), getDefaultScheduleValue(), getDescription(), getId(), getTitle(), hasAutoActivation(), hasFlexibleSchedule(), ILIAS\Repository\int(), and run().

Referenced by ilCronManagerImpl\activateJob(), ilCronJobRepositoryImpl\createDefaultEntry(), and ilCronManagerImpl\deactivateJob().

                                                                                                          : void
     {
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomSettingsToForm()

ilCronJob::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 251 of file class.ilCronJob.php.

                                                                       : void
     {
     }

◆ addToExternalSettingsForm()

ilCronJob::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Definition at line 260 of file class.ilCronJob.php.

                                                                                                   : void
     {
     }

◆ checkSchedule()

ilCronJob::checkSchedule	(	?DateTimeImmutable	$last_run,
		?CronJobScheduleType	$schedule_type,
		?int	$schedule_value
	)

private

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

References $date_time_provider, checkWeeklySchedule(), and ILIAS\Cron\Schedule\SCHEDULE_TYPE_YEARLY.

Referenced by isDue().

                                                                                                                            : bool
     {
         if (null === $schedule_type) {
             return false;
         }
 
         if (null === $last_run) {
             return true;
         }
 
         if ($this->date_time_provider === null) {
             $now = new DateTimeImmutable('@' . time(), new DateTimeZone(date_default_timezone_get()));
         } else {
             $now = ($this->date_time_provider)();
         }
 
         switch ($schedule_type) {
             case CronJobScheduleType::SCHEDULE_TYPE_DAILY:
                 $last = $last_run->format('Y-m-d');
                 $ref = $now->format('Y-m-d');
                 return ($last !== $ref);
 
             case CronJobScheduleType::SCHEDULE_TYPE_WEEKLY:
                 return $this->checkWeeklySchedule($last_run, $now);
 
             case CronJobScheduleType::SCHEDULE_TYPE_MONTHLY:
                 $last = $last_run->format('Y-n');
                 $ref = $now->format('Y-n');
                 return ($last !== $ref);
 
             case CronJobScheduleType::SCHEDULE_TYPE_QUARTERLY:
                 $last = $last_run->format('Y') . '-' . ceil(((int) $last_run->format('n')) / 3);
                 $ref = $now->format('Y') . '-' . ceil(((int) $now->format('n')) / 3);
                 return ($last !== $ref);
 
             case CronJobScheduleType::SCHEDULE_TYPE_YEARLY:
                 $last = $last_run->format('Y');
                 $ref = $now->format('Y');
                 return ($last !== $ref);
 
             case CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES:
                 $diff = floor(($now->getTimestamp() - $last_run->getTimestamp()) / 60);
                 return ($diff >= $schedule_value);
 
             case CronJobScheduleType::SCHEDULE_TYPE_IN_HOURS:
                 $diff = floor(($now->getTimestamp() - $last_run->getTimestamp()) / (60 * 60));
                 return ($diff >= $schedule_value);
 
             case CronJobScheduleType::SCHEDULE_TYPE_IN_DAYS:
                 $diff = floor(($now->getTimestamp() - $last_run->getTimestamp()) / (60 * 60 * 24));
                 return ($diff >= $schedule_value);
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkWeeklySchedule()

ilCronJob::checkWeeklySchedule	(	DateTimeImmutable	$last_run,
		DateTimeImmutable	$now
	)

private

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

References ILIAS\Repository\int().

Referenced by checkSchedule().

                                                                                              : bool
     {
         $last_year = (int) $last_run->format('Y');
         $now_year = (int) $now->format('Y');
 
         if ($last_year > $now_year) {
             // Should never happen, don't execute otherwise
             return false;
         }
 
         $last_week = $last_run->format('W');
         $now_week = $now->format('W');
 
         if ($last_week !== $now_week) {
             // Week differs, always execute the job
             return true;
         }
 
         // For all following cases, the week number is always identical
 
         $last_month = (int) $last_run->format('m');
         $now_month = (int) $now->format('m');
 
         $is_within_same_week_in_same_year = ($last_year . '-' . $last_week) === ($now_year . '-' . $now_week);
         if ($is_within_same_week_in_same_year) {
             // Same week in same year, only execute if the month differs (2022-52 is valid for January and December)
             return $last_month !== $now_month && $now->diff($last_run)->d > 7;
         }
 
         if ($now_year - $last_year > 1) {
             // Always execute if the difference of years is greater than 1
             return true;
         }
 
         // Execute for week number 52 in 2022 (last run) and week number 52 in December of 2022 (now), but not for week number 52 in January of 2022 (now)
         return $last_month === $now_month;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllScheduleTypes()

ilCronJob::getAllScheduleTypes ( )

Get all available schedule types.

Returns: list<CronJobScheduleType>

Definition at line 215 of file class.ilCronJob.php.

Referenced by getValidScheduleTypes().

                                          : array
     {
         return CronJobScheduleType::cases();
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCronJob::getDefaultScheduleType ( )

abstract

Referenced by activationWasToggled(), ilCronJobRepositoryImpl\createDefaultEntry(), and isDue().

Here is the caller graph for this function:

◆ getDefaultScheduleValue()

ilCronJob::getDefaultScheduleValue ( )

abstract

Referenced by activationWasToggled(), ilCronJobRepositoryImpl\createDefaultEntry(), and isDue().

Here is the caller graph for this function:

◆ getDescription()

ilCronJob::getDescription ( )

abstract

Referenced by activationWasToggled().

Here is the caller graph for this function:

◆ getId()

ilCronJob::getId ( )

abstract

Referenced by ilCronJobRepositoryImpl\activateJob(), activationWasToggled(), ilCronJobRepositoryImpl\createDefaultEntry(), ilCronJobRepositoryImpl\deactivateJob(), ilCronJobRepositoryImpl\getJobInstance(), ilCronJobRepositoryImpl\resetJob(), ilCronManagerImpl\runJob(), ilCronJobRepositoryImpl\updateJobResult(), and ilCronJobRepositoryImpl\updateJobSchedule().

Here is the caller graph for this function:

◆ getScheduleType()

ilCronJob::getScheduleType ( )

Get current schedule type (if flexible)

Definition at line 175 of file class.ilCronJob.php.

References $schedule_type, and hasFlexibleSchedule().

Referenced by CronJobScheduleTest\testWeeklySchedules().

                                      : ?CronJobScheduleType
     {
         if ($this->schedule_type && $this->hasFlexibleSchedule()) {
             return $this->schedule_type;
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScheduleTypesWithValues()

ilCronJob::getScheduleTypesWithValues ( )

Returns: list<CronJobScheduleType>

Definition at line 223 of file class.ilCronJob.php.

                                                 : array
     {
         return [
             CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES,
             CronJobScheduleType::SCHEDULE_TYPE_IN_HOURS,
             CronJobScheduleType::SCHEDULE_TYPE_IN_DAYS,
         ];
     }

◆ getScheduleValue()

ilCronJob::getScheduleValue ( )

Get current schedule value (if flexible)

Definition at line 187 of file class.ilCronJob.php.

References $schedule_value, and hasFlexibleSchedule().

Referenced by CronJobScheduleTest\testWeeklySchedules().

                                       : ?int
     {
         if ($this->schedule_value && $this->hasFlexibleSchedule()) {
             return $this->schedule_value;
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilCronJob::getTitle ( )

abstract

Referenced by activationWasToggled().

Here is the caller graph for this function:

◆ getValidScheduleTypes()

ilCronJob::getValidScheduleTypes ( )

Returns a collection of all valid schedule types for a specific job.

Returns: list<CronJobScheduleType>

Definition at line 236 of file class.ilCronJob.php.

References getAllScheduleTypes().

Referenced by setSchedule(), and ilCronJobRepositoryImpl\updateJobSchedule().

                                            : array
     {
         return $this->getAllScheduleTypes();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ilCronJob::hasAutoActivation ( )

abstract

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

Referenced by activationWasToggled(), and ilCronJobRepositoryImpl\createDefaultEntry().

Here is the caller graph for this function:

◆ hasCustomSettings()

ilCronJob::hasCustomSettings ( )

Definition at line 246 of file class.ilCronJob.php.

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilCronJob::hasFlexibleSchedule ( )

abstract

Referenced by activationWasToggled(), ilCronJobRepositoryImpl\createDefaultEntry(), getScheduleType(), getScheduleValue(), isDue(), setSchedule(), and ilCronJobRepositoryImpl\updateJobSchedule().

Here is the caller graph for this function:

◆ isDue()

ilCronJob::isDue	(	?DateTimeImmutable	$last_run,
		?CronJobScheduleType	$schedule_type,
		?int	$schedule_value,
		bool	$is_manually_executed = `false`
	)

Definition at line 154 of file class.ilCronJob.php.

References checkSchedule(), getDefaultScheduleType(), getDefaultScheduleValue(), and hasFlexibleSchedule().

Referenced by ilCronManagerImpl\runJob(), CronJobScheduleTest\testSchedule(), and CronJobScheduleTest\testWeeklySchedules().

      : bool {
         if ($is_manually_executed) {
             return true;
         }
 
         if (!$this->hasFlexibleSchedule()) {
             $schedule_type = $this->getDefaultScheduleType();
             $schedule_value = $this->getDefaultScheduleValue();
         }
 
         return $this->checkSchedule($last_run, $schedule_type, $schedule_value);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isManuallyExecutable()

ilCronJob::isManuallyExecutable ( )

Definition at line 241 of file class.ilCronJob.php.

Referenced by ilCronManagerGUI\confirm().

                                           : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ run()

ilCronJob::run ( )

abstract

Referenced by activationWasToggled(), and ilCronManagerImpl\runJob().

Here is the caller graph for this function:

◆ saveCustomSettings()

ilCronJob::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 255 of file class.ilCronJob.php.

                                                                  : bool
     {
         return true;
     }

◆ setDateTimeProvider()

ilCronJob::setDateTimeProvider ( ?Closure $date_time_provider )

Parameters

Closure():DateTimeInterface|null $date_time_provider

Definition at line 126 of file class.ilCronJob.php.

References $date_time_provider, and $r.

Referenced by ilCronManagerImpl\runJob().

                                                                      : void
     {
         if ($date_time_provider !== null) {
             $r = new ReflectionFunction($date_time_provider);
             $return_type = $r->getReturnType();
             if ($return_type !== null) {
                 $return_type = $return_type->getName();
             }
             $expected_type = DateTimeInterface::class;
             if (!is_subclass_of($return_type, $expected_type)) {
                 throw new InvalidArgumentException(sprintf(
                     'The return type of the datetime provider must be of type %s',
                     $expected_type
                 ));
             }
 
             $r = new ReflectionFunction($date_time_provider);
             $parameters = $r->getParameters();
             if ($parameters !== []) {
                 throw new InvalidArgumentException(
                     'The datetime provider must not define any parameters',
                 );
             }
         }
 
         $this->date_time_provider = $date_time_provider;
     }

Here is the caller graph for this function:

◆ setSchedule()

ilCronJob::setSchedule	(	?CronJobScheduleType	$a_type,
		?int	$a_value
	)

Update current schedule (if flexible)

Definition at line 199 of file class.ilCronJob.php.

References getValidScheduleTypes(), and hasFlexibleSchedule().

                                                                             : void
     {
         if (
             $a_value &&
             $this->hasFlexibleSchedule() &&
             in_array($a_type, $this->getValidScheduleTypes(), true)
         ) {
             $this->schedule_type = $a_type;
             $this->schedule_value = $a_value;
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $date_time_provider

Closure ilCronJob::$date_time_provider = null

protected

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

Referenced by checkSchedule(), and setDateTimeProvider().

◆ $schedule_type

CronJobScheduleType ilCronJob::$schedule_type = null

protected

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

Referenced by getScheduleType().

◆ $schedule_value

int ilCronJob::$schedule_value = null

protected

Definition at line 26 of file class.ilCronJob.php.

Referenced by getScheduleValue().

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

components/ILIAS/Cron/classes/class.ilCronJob.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ addToExternalSettingsForm()

◆ checkSchedule()

◆ checkWeeklySchedule()

◆ getAllScheduleTypes()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getScheduleType()

◆ getScheduleTypesWithValues()

◆ getScheduleValue()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ isDue()

◆ isManuallyExecutable()

◆ run()

◆ saveCustomSettings()

◆ setDateTimeProvider()

◆ setSchedule()

Field Documentation

◆ $date_time_provider

◆ $schedule_type

◆ $schedule_value