Cron job application base class. More...

Inheritance diagram for ilCronJob:

Collaboration diagram for ilCronJob:

Public Member Functions
	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	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 Member Functions
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

Cron job application base class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ activationWasToggled()

ilCronJob::activationWasToggled ( $a_currently_active )

Cron job status was changed.

Parameters

bool $a_currently_active

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

References getDefaultScheduleType(), getDefaultScheduleValue(), getId(), hasAutoActivation(), hasFlexibleSchedule(), and run().

Referenced by ilCronManager\activateJob(), ilCronManager\createDefaultEntry(), and ilCronManager\deactivateJob().

     {
         // we cannot use ilObject or any higher level construct here
         // this may be called from setup, so it is limited to handling ilSetting/ilDB mostly
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomSettingsToForm()

ilCronJob::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Add custom settings to form.

Parameters

ilPropertyFormGUI $a_form

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

237 {

238 }

◆ addToExternalSettingsForm()

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

Add external settings to form.

Parameters

int	$a_form_id
array	$a_fields
bool	$a_is_active

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

259 {

260 }

◆ checkSchedule()

ilCronJob::checkSchedule	(	$a_ts_last_run,
		$a_schedule_type,
		$a_schedule_value
	)

protected

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

Referenced by isActive().

     {
         if (!$a_schedule_type) {
             return false;
         }
         if (!$a_ts_last_run) {
             return true;
         }
         
         $now = time();
         
         switch ($a_schedule_type) {
             case self::SCHEDULE_TYPE_DAILY:
                 $last = date("Y-m-d", $a_ts_last_run);
                 $ref = date("Y-m-d", $now);
                 return ($last != $ref);
                 
             case self::SCHEDULE_TYPE_WEEKLY:
                 $last = date("Y-W", $a_ts_last_run);
                 $ref = date("Y-W", $now);
                 return ($last != $ref);
                 
             case self::SCHEDULE_TYPE_MONTHLY:
                 $last = date("Y-n", $a_ts_last_run);
                 $ref = date("Y-n", $now);
                 return ($last != $ref);
                 
             case self::SCHEDULE_TYPE_QUARTERLY:
                 $last = date("Y", $a_ts_last_run) . "-" . ceil(date("n", $a_ts_last_run) / 3);
                 $ref = date("Y", $now) . "-" . ceil(date("n", $now) / 3);
                 return ($last != $ref);
                 
             case self::SCHEDULE_TYPE_YEARLY:
                 $last = date("Y", $a_ts_last_run);
                 $ref = date("Y", $now);
                 return ($last != $ref);
             
             case self::SCHEDULE_TYPE_IN_MINUTES:
                 $diff = floor(($now - $a_ts_last_run) / 60);
                 return ($diff >= $a_schedule_value);
                 
             case self::SCHEDULE_TYPE_IN_HOURS:
                 $diff = floor(($now - $a_ts_last_run) / (60 * 60));
                 return ($diff >= $a_schedule_value);
                 
             case self::SCHEDULE_TYPE_IN_DAYS:
                 $diff = floor(($now - $a_ts_last_run) / (60 * 60 * 24));
                 return ($diff >= $a_schedule_value);
         }
     }

Here is the caller graph for this function:

◆ getAllScheduleTypes()

ilCronJob::getAllScheduleTypes ( )

Get all available schedule types.

Returns: int[]

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

Referenced by getValidScheduleTypes().

     {
         return array(
             self::SCHEDULE_TYPE_DAILY,
             self::SCHEDULE_TYPE_WEEKLY,
             self::SCHEDULE_TYPE_MONTHLY,
             self::SCHEDULE_TYPE_QUARTERLY,
             self::SCHEDULE_TYPE_YEARLY,
             self::SCHEDULE_TYPE_IN_MINUTES,
             self::SCHEDULE_TYPE_IN_HOURS,
             self::SCHEDULE_TYPE_IN_DAYS
         );
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCronJob::getDefaultScheduleType ( )

abstract

Get schedule type.

Returns: int

Referenced by activationWasToggled(), ilCronManager\createDefaultEntry(), isActive(), and ilCronManagerTableGUI\parseJobToData().

Here is the caller graph for this function:

◆ getDefaultScheduleValue()

ilCronJob::getDefaultScheduleValue ( )

abstract

Get schedule value.

Returns: int|array

Referenced by activationWasToggled(), ilCronManager\createDefaultEntry(), isActive(), and ilCronManagerTableGUI\parseJobToData().

Here is the caller graph for this function:

◆ getDescription()

ilCronJob::getDescription ( )

Get description.

Returns: string

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

Referenced by ilCronManagerTableGUI\parseJobToData().

205 {

206 }

Here is the caller graph for this function:

◆ getId()

ilCronJob::getId ( )

abstract

Get id.

Returns: string

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

Here is the caller graph for this function:

◆ getScheduleType()

ilCronJob::getScheduleType ( )

Get current schedule type (if flexible)

Returns: int

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

References hasFlexibleSchedule().

Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod().

     {
         if ($this->hasFlexibleSchedule() && $this->schedule_type) {
             return $this->schedule_type;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScheduleTypesWithValues()

ilCronJob::getScheduleTypesWithValues ( )

Returns: int[]

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

References SCHEDULE_TYPE_IN_DAYS, SCHEDULE_TYPE_IN_HOURS, and SCHEDULE_TYPE_IN_MINUTES.

     {
         return [
             ilCronJob::SCHEDULE_TYPE_IN_MINUTES,
             ilCronJob::SCHEDULE_TYPE_IN_HOURS,
             ilCronJob::SCHEDULE_TYPE_IN_DAYS
         ];
     }

◆ getScheduleValue()

ilCronJob::getScheduleValue ( )

Get current schedule value (if flexible)

Returns: int

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

References hasFlexibleSchedule().

     {
         if ($this->hasFlexibleSchedule() && $this->schedule_value) {
             return $this->schedule_value;
         }
     }

Here is the call graph for this function:

◆ getTitle()

ilCronJob::getTitle ( )

Get title.

Returns: string

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

Referenced by ilCronManagerTableGUI\parseJobToData().

196 {

197 }

Here is the caller graph for this function:

◆ getValidScheduleTypes()

ilCronJob::getValidScheduleTypes ( )

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

Returns: int[]

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

References getAllScheduleTypes().

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

     {
         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".

Returns: boolean

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

Here is the caller graph for this function:

◆ hasCustomSettings()

ilCronJob::hasCustomSettings ( )

Has cron job any custom setting which can be edited?

Returns: boolean

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

Referenced by ilCronManagerTableGUI\parseJobToData().

     {
         return false;
     }

Here is the caller graph for this function:

◆ hasFlexibleSchedule()

ilCronJob::hasFlexibleSchedule ( )

abstract

Can the schedule be configured?

Returns: boolean

Referenced by activationWasToggled(), ilCronManager\createDefaultEntry(), getScheduleType(), getScheduleValue(), isActive(), ilCronManagerTableGUI\parseJobToData(), setSchedule(), and ilCronManager\updateJobSchedule().

Here is the caller graph for this function:

◆ isActive()

ilCronJob::isActive	(	$a_ts_last_run,
		$a_schedule_type,
		$a_schedule_value,
		$a_manual = `false`
	)

Is job currently active?

Parameters

timestamp	$a_ts_last_run
integer	$a_ts_last_run
integer	$a_ts_last_run
bool	$a_ts_last_run

Returns: boolean

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

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

Referenced by ilCronManager\runJob().

     {
         if ($a_manual) {
             return true;
         }
         if (!$this->hasFlexibleSchedule()) {
             $a_schedule_type = $this->getDefaultScheduleType();
             $a_schedule_value = $this->getDefaultScheduleValue();
         }
         return $this->checkSchedule($a_ts_last_run, $a_schedule_type, $a_schedule_value);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isManuallyExecutable()

ilCronJob::isManuallyExecutable ( )

Defines whether or not a cron job can be started manually.

Returns: bool

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

Referenced by ilCronManagerTableGUI\parseJobToData().

     {
         return true;
     }

Here is the caller graph for this function:

◆ run()

ilCronJob::run ( )

abstract

Run job.

Returns: ilCronJobResult

Referenced by activationWasToggled(), ilCronDeleteInactiveUserAccounts\hasCustomSettings(), ilUserCronCheckAccounts\hasFlexibleSchedule(), and ilCronManager\runJob().

Here is the caller graph for this function:

◆ saveCustomSettings()

ilCronJob::saveCustomSettings ( ilPropertyFormGUI $a_form )

Save custom settings.

Parameters

ilPropertyFormGUI $a_form

Returns: boolean

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

     {
         return true;
     }

◆ setSchedule()

ilCronJob::setSchedule	(	$a_type,
		$a_value
	)

Update current schedule (if flexible)

Parameters

integer	$a_type
integer	$a_value

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

References $a_type, getValidScheduleTypes(), and hasFlexibleSchedule().

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

Here is the call graph for this function:

Field Documentation

◆ SCHEDULE_TYPE_DAILY

const ilCronJob::SCHEDULE_TYPE_DAILY = 1

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), and ilCronManagerTableGUI\parseJobToData().

◆ SCHEDULE_TYPE_IN_DAYS

const ilCronJob::SCHEDULE_TYPE_IN_DAYS = 4

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), getScheduleTypesWithValues(), ilCronManagerGUI\getScheduleValueFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\hasScheduleValue(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().

◆ SCHEDULE_TYPE_IN_HOURS

const ilCronJob::SCHEDULE_TYPE_IN_HOURS = 3

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), getScheduleTypesWithValues(), ilCronManagerGUI\getScheduleValueFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\hasScheduleValue(), and ilCronManagerTableGUI\parseJobToData().

◆ SCHEDULE_TYPE_IN_MINUTES

const ilCronJob::SCHEDULE_TYPE_IN_MINUTES = 2

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), getScheduleTypesWithValues(), ilCronManagerGUI\getScheduleValueFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\hasScheduleValue(), and ilCronManagerTableGUI\parseJobToData().

◆ SCHEDULE_TYPE_MONTHLY

const ilCronJob::SCHEDULE_TYPE_MONTHLY = 6

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().

◆ SCHEDULE_TYPE_QUARTERLY

const ilCronJob::SCHEDULE_TYPE_QUARTERLY = 7

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().

◆ SCHEDULE_TYPE_WEEKLY

const ilCronJob::SCHEDULE_TYPE_WEEKLY = 5

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().

◆ SCHEDULE_TYPE_YEARLY

const ilCronJob::SCHEDULE_TYPE_YEARLY = 8

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

Referenced by ilCronManagerGUI\getScheduleTypeFormElementName(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().

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

Services/Cron/classes/class.ilCronJob.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ addToExternalSettingsForm()

◆ checkSchedule()

◆ getAllScheduleTypes()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getScheduleType()

◆ getScheduleTypesWithValues()

◆ getScheduleValue()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ isActive()

◆ isManuallyExecutable()

◆ run()

◆ saveCustomSettings()

◆ setSchedule()

Field Documentation

◆ SCHEDULE_TYPE_DAILY

◆ SCHEDULE_TYPE_IN_DAYS

◆ SCHEDULE_TYPE_IN_HOURS

◆ SCHEDULE_TYPE_IN_MINUTES

◆ SCHEDULE_TYPE_MONTHLY

◆ SCHEDULE_TYPE_QUARTERLY

◆ SCHEDULE_TYPE_WEEKLY

◆ SCHEDULE_TYPE_YEARLY