Inheritance diagram for ILIAS\Cron\CronJob:

Collaboration diagram for ILIAS\Cron\CronJob:

Public Member Functions
	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
JobScheduleType	$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, ?JobScheduleType $schedule_type, ?int $schedule_value)

Detailed Description

Definition at line 26 of file CronJob.php.

Member Function Documentation

◆ activationWasToggled()

ILIAS\Cron\CronJob::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 287 of file CronJob.php.

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

                                                                                                            : void
     {
     }

Here is the call graph for this function:

◆ addCustomSettingsToForm()

ILIAS\Cron\CronJob::addCustomSettingsToForm ( \ilPropertyFormGUI $a_form )

Deprecated:

Definition at line 253 of file CronJob.php.

Referenced by ilCronManagerGUI\initLegacyEditForm().

                                                                        : void
     {
     }

Here is the caller graph for this function:

◆ addToExternalSettingsForm()

ILIAS\Cron\CronJob::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Parameters

array<string,mixed> $a_fields

Definition at line 279 of file CronJob.php.

                                                                                                   : void
     {
     }

◆ checkSchedule()

ILIAS\Cron\CronJob::checkSchedule	(	?\DateTimeImmutable	$last_run,
		?JobScheduleType	$schedule_type,
		?int	$schedule_value
	)

private

Definition at line 43 of file CronJob.php.

References ILIAS\Cron\CronJob\$date_time_provider, ILIAS\Cron\CronJob\checkWeeklySchedule(), null, and ILIAS\Cron\Job\Schedule\YEARLY.

Referenced by ILIAS\Cron\CronJob\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 JobScheduleType::DAILY:
                 $last = $last_run->format('Y-m-d');
                 $ref = $now->format('Y-m-d');
                 return ($last !== $ref);
 
             case JobScheduleType::WEEKLY:
                 return $this->checkWeeklySchedule($last_run, $now);
 
             case JobScheduleType::MONTHLY:
                 $last = $last_run->format('Y-n');
                 $ref = $now->format('Y-n');
                 return ($last !== $ref);
 
             case JobScheduleType::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 JobScheduleType::YEARLY:
                 $last = $last_run->format('Y');
                 $ref = $now->format('Y');
                 return ($last !== $ref);
 
             case JobScheduleType::IN_MINUTES:
                 $diff = floor(($now->getTimestamp() - $last_run->getTimestamp()) / 60);
                 return ($diff >= $schedule_value);
 
             case JobScheduleType::IN_HOURS:
                 $diff = floor(($now->getTimestamp() - $last_run->getTimestamp()) / (60 * 60));
                 return ($diff >= $schedule_value);
 
             case JobScheduleType::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()

ILIAS\Cron\CronJob::checkWeeklySchedule	(	\DateTimeImmutable	$last_run,
		\DateTimeImmutable	$now
	)

private

Definition at line 32 of file CronJob.php.

Referenced by ILIAS\Cron\CronJob\checkSchedule().

                                                                                                : bool
     {
         if ($last_run > $now) {
             // Defensive check: last run is in the future → don't run again
             return false;
         }
 
         // We are using ISO week/year to handle issues with week #52/#53 (see: https://mantis.ilias.de/view.php?id=36118 / https://en.wikipedia.org/wiki/ISO_8601#Week_dates)
         return $last_run->format('o-W') !== $now->format('o-W');
     }

Here is the caller graph for this function:

◆ getAllScheduleTypes()

ILIAS\Cron\CronJob::getAllScheduleTypes ( )

Get all available schedule types.

Returns: list<JobScheduleType>

Definition at line 196 of file CronJob.php.

Referenced by ILIAS\Cron\CronJob\getValidScheduleTypes(), ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().

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

Here is the caller graph for this function:

◆ getCustomConfigurationInput()

ILIAS\Cron\CronJob::getCustomConfigurationInput	(	\ILIAS\UI\Factory	$ui_factory,
		\ILIAS\Refinery\Factory	$factory,
		\ilLanguage	$lng
	)

Definition at line 241 of file CronJob.php.

Referenced by ilCronManagerGUI\initEditForm().

      : \ILIAS\UI\Component\Input\Container\Form\FormInput {
         throw new \RuntimeException('Not implemented');
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ILIAS\Cron\CronJob::getDefaultScheduleType ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled(), and ILIAS\Cron\CronJob\isDue().

Here is the caller graph for this function:

◆ getDefaultScheduleValue()

ILIAS\Cron\CronJob::getDefaultScheduleValue ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled(), and ILIAS\Cron\CronJob\isDue().

Here is the caller graph for this function:

◆ getDescription()

ILIAS\Cron\CronJob::getDescription ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled().

Here is the caller graph for this function:

◆ getId()

ILIAS\Cron\CronJob::getId ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled(), ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().

Here is the caller graph for this function:

◆ getScheduleType()

ILIAS\Cron\CronJob::getScheduleType ( )

Get current schedule type (if flexible)

Definition at line 156 of file CronJob.php.

References ILIAS\Cron\CronJob\$schedule_type, ILIAS\Cron\CronJob\hasFlexibleSchedule(), and null.

Referenced by CronJobScheduleTest\testWeeklySchedules().

                                      : ?JobScheduleType
     {
         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()

ILIAS\Cron\CronJob::getScheduleTypesWithValues ( )

Returns: list<JobScheduleType>

Definition at line 204 of file CronJob.php.

Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().

                                                 : array
     {
         return [
             JobScheduleType::IN_MINUTES,
             JobScheduleType::IN_HOURS,
             JobScheduleType::IN_DAYS,
         ];
     }

Here is the caller graph for this function:

◆ getScheduleValue()

ILIAS\Cron\CronJob::getScheduleValue ( )

Get current schedule value (if flexible)

Definition at line 168 of file CronJob.php.

References ILIAS\Cron\CronJob\$schedule_value, ILIAS\Cron\CronJob\hasFlexibleSchedule(), and null.

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

ILIAS\Cron\CronJob::getTitle ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled(), ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().

Here is the caller graph for this function:

◆ getValidScheduleTypes()

ILIAS\Cron\CronJob::getValidScheduleTypes ( )

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

Returns: list<JobScheduleType>

Definition at line 217 of file CronJob.php.

References ILIAS\Cron\CronJob\getAllScheduleTypes().

Referenced by ilCronManagerGUI\initEditForm(), ilCronManagerGUI\initLegacyEditForm(), and ILIAS\Cron\CronJob\setSchedule().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ILIAS\Cron\CronJob::hasAutoActivation ( )

abstract

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

Referenced by ILIAS\Cron\CronJob\activationWasToggled().

Here is the caller graph for this function:

◆ hasCustomSettings()

ILIAS\Cron\CronJob::hasCustomSettings ( )

Definition at line 227 of file CronJob.php.

Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().

                                        : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ hasFlexibleSchedule()

ILIAS\Cron\CronJob::hasFlexibleSchedule ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled(), ILIAS\Cron\CronJob\getScheduleType(), ILIAS\Cron\CronJob\getScheduleValue(), ilCronManagerGUI\initEditForm(), ilCronManagerGUI\initLegacyEditForm(), ILIAS\Cron\CronJob\isDue(), and ILIAS\Cron\CronJob\setSchedule().

Here is the caller graph for this function:

◆ isDue()

ILIAS\Cron\CronJob::isDue	(	?\DateTimeImmutable	$last_run,
		?JobScheduleType	$schedule_type,
		?int	$schedule_value,
		bool	$is_manually_executed = `false`
	)

Definition at line 135 of file CronJob.php.

References ILIAS\Cron\CronJob\checkSchedule(), ILIAS\Cron\CronJob\getDefaultScheduleType(), ILIAS\Cron\CronJob\getDefaultScheduleValue(), and ILIAS\Cron\CronJob\hasFlexibleSchedule().

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

ILIAS\Cron\CronJob::isManuallyExecutable ( )

Definition at line 222 of file CronJob.php.

Referenced by ilCronManagerGUI\confirm().

                                           : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ run()

ILIAS\Cron\CronJob::run ( )

abstract

Referenced by ILIAS\Cron\CronJob\activationWasToggled().

Here is the caller graph for this function:

◆ saveCustomConfiguration()

ILIAS\Cron\CronJob::saveCustomConfiguration ( mixed $form_data )

Parameters

mixed $form_data The form data provided by the KS (::getData)). The types and structure depend on the structure provided by getCustomConfigurationInput. It might be a single value or a array<string, mixed>-like structure.

Definition at line 262 of file CronJob.php.

                                                              : void
     {
         throw new \RuntimeException('Not implemented');
     }

◆ saveCustomSettings()

ILIAS\Cron\CronJob::saveCustomSettings ( \ilPropertyFormGUI $a_form )

Deprecated:

Definition at line 271 of file CronJob.php.

                                                                   : bool
     {
         return true;
     }

◆ setDateTimeProvider()

ILIAS\Cron\CronJob::setDateTimeProvider ( ?\Closure $date_time_provider )

Parameters

Definition at line 105 of file CronJob.php.

References ILIAS\Cron\CronJob\$date_time_provider, $r, and null.

                                                                       : void
     {
         if ($date_time_provider !== null) {
             $r = new \ReflectionFunction($date_time_provider);
             $return_type = $r->getReturnType();
             if ($return_type instanceof \ReflectionNamedType) {
                 $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;
     }

◆ setSchedule()

ILIAS\Cron\CronJob::setSchedule	(	?JobScheduleType	$a_type,
		?int	$a_value
	)

Update current schedule (if flexible)

Definition at line 180 of file CronJob.php.

References ILIAS\Cron\CronJob\getValidScheduleTypes(), and ILIAS\Cron\CronJob\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:

◆ usesLegacyForms()

ILIAS\Cron\CronJob::usesLegacyForms ( )

Deprecated:

Definition at line 236 of file CronJob.php.

                                      : bool
     {
         return true;
     }

Field Documentation

◆ $date_time_provider

Closure ILIAS\Cron\CronJob::$date_time_provider = null

protected

Definition at line 30 of file CronJob.php.

Referenced by ILIAS\Cron\CronJob\checkSchedule(), and ILIAS\Cron\CronJob\setDateTimeProvider().

◆ $schedule_type

JobScheduleType ILIAS\Cron\CronJob::$schedule_type = null

protected

Definition at line 28 of file CronJob.php.

Referenced by ILIAS\Cron\CronJob\getScheduleType().

◆ $schedule_value

int ILIAS\Cron\CronJob::$schedule_value = null

protected

Definition at line 29 of file CronJob.php.

Referenced by ILIAS\Cron\CronJob\getScheduleValue().

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

components/ILIAS/Cron/src/CronJob.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ addToExternalSettingsForm()

◆ checkSchedule()

◆ checkWeeklySchedule()

◆ getAllScheduleTypes()

◆ getCustomConfigurationInput()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getScheduleType()

◆ getScheduleTypesWithValues()

◆ getScheduleValue()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ isDue()

◆ isManuallyExecutable()

◆ run()

◆ saveCustomConfiguration()

◆ saveCustomSettings()

◆ setDateTimeProvider()

◆ setSchedule()

◆ usesLegacyForms()

Field Documentation

◆ $date_time_provider

◆ $schedule_type

◆ $schedule_value