ilCronJobRepository Interface Reference

Inheritance diagram for ilCronJobRepository:

Collaboration diagram for ilCronJobRepository:

Public Member Functions
	getJobInstanceById (string $id)
	getJobInstance (string $a_id, string $a_component, string $a_class, bool $isCreationContext=false)
	getCronJobData ($id=null, bool $withInactiveJobsIncluded=true)
	Get cron job configuration/execution data. More...
	registerJob (string $a_component, string $a_id, string $a_class, ?string $a_path)
	unregisterJob (string $a_component, array $a_xml_job_ids)
	createDefaultEntry (ilCronJob $job, string $component, string $class, ?string $path)
	getPluginJobs (bool $withOnlyActive=false)
	resetJob (ilCronJob $job)
	updateJobResult (ilCronJob $job, DateTimeImmutable $when, ilObjUser $actor, ilCronJobResult $result, bool $wasManualExecution=false)
	updateRunInformation (string $jobId, int $runningTimestamp, int $aliveTimestamp)
	updateJobSchedule (ilCronJob $job, ?int $scheduleType, ?int $scheduleValue)
	activateJob (ilCronJob $job, DateTimeImmutable $when, ilObjUser $actor, bool $wasManuallyExecuted=false)
	deactivateJob (ilCronJob $job, DateTimeImmutable $when, ilObjUser $actor, bool $wasManuallyExecuted=false)
	findAll ()

Detailed Description

Definition at line 21 of file interface.ilCronJobRepository.php.

Member Function Documentation

activateJob()

ilCronJobRepository::activateJob	(	ilCronJob	$job,
		DateTimeImmutable	$when,
		ilObjUser	$actor,
		bool	$wasManuallyExecuted = false
	)

createDefaultEntry()

ilCronJobRepository::createDefaultEntry	(	ilCronJob	$job,
		string	$component,
		string	$class,
		?string	$path
	)

Implemented in ilCronJobRepositoryImpl.

deactivateJob()

ilCronJobRepository::deactivateJob	(	ilCronJob	$job,
		DateTimeImmutable	$when,
		ilObjUser	$actor,
		bool	$wasManuallyExecuted = false
	)

Implemented in ilCronJobRepositoryImpl.

findAll()

ilCronJobRepository::findAll

(

)

Implemented in ilCronJobRepositoryImpl.

getCronJobData()

ilCronJobRepository::getCronJobData	(		$id = null,
		bool	$withInactiveJobsIncluded = true
	)

Get cron job configuration/execution data.

Parameters

array | string | null	$id
bool	$withInactiveJobsIncluded

Returns

array<int, array<string, mixed>>

Implemented in ilCronJobRepositoryImpl.

getJobInstance()

ilCronJobRepository::getJobInstance	(	string	$a_id,
		string	$a_component,
		string	$a_class,
		bool	$isCreationContext = false
	)

Implemented in ilCronJobRepositoryImpl.

getJobInstanceById()

ilCronJobRepository::getJobInstanceById

(

string

$id

)

Implemented in ilCronJobRepositoryImpl.

getPluginJobs()

ilCronJobRepository::getPluginJobs

(

bool

$withOnlyActive = false

)

Parameters

bool

$withOnlyActive

Returns

array<int, array{0: ilCronJob, 1: array<string, mixed>}>

Implemented in ilCronJobRepositoryImpl.

registerJob()

ilCronJobRepository::registerJob	(	string	$a_component,
		string	$a_id,
		string	$a_class,
		?string	$a_path
	)

Implemented in ilCronJobRepositoryImpl.

resetJob()

ilCronJobRepository::resetJob

(

ilCronJob

$job

)

Implemented in ilCronJobRepositoryImpl.

unregisterJob()

ilCronJobRepository::unregisterJob	(	string	$a_component,
		array	$a_xml_job_ids
	)

Implemented in ilCronJobRepositoryImpl.

updateJobResult()

ilCronJobRepository::updateJobResult	(	ilCronJob	$job,
		DateTimeImmutable	$when,
		ilObjUser	$actor,
		ilCronJobResult	$result,
		bool	$wasManualExecution = false
	)

Implemented in ilCronJobRepositoryImpl.

updateJobSchedule()

ilCronJobRepository::updateJobSchedule	(	ilCronJob	$job,
		?int	$scheduleType,
		?int	$scheduleValue
	)

Implemented in ilCronJobRepositoryImpl.

updateRunInformation()

ilCronJobRepository::updateRunInformation	(	string	$jobId,
		int	$runningTimestamp,
		int	$aliveTimestamp
	)

Implemented in ilCronJobRepositoryImpl.

---

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

• Services/Cron/interfaces/interface.ilCronJobRepository.php