ILIAS\BackgroundTasks\Task\Job\JobRepository Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Task\Job\JobRepository:

Collaboration diagram for ILIAS\BackgroundTasks\Task\Job\JobRepository:

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 (\ILIAS\Cron\CronJob $job, string $component, string $class, ?string $path)
	getPluginJobs (bool $withOnlyActive=false)
	resetJob (\ILIAS\Cron\CronJob $job)
	updateJobResult (\ILIAS\Cron\CronJob $job, \DateTimeImmutable $when, \ilObjUser $actor, JobResult $result, bool $wasManualExecution=false)
	updateRunInformation (string $jobId, int $runningTimestamp, int $aliveTimestamp)
	updateJobSchedule (\ILIAS\Cron\CronJob $job, ?JobScheduleType $scheduleType, ?int $scheduleValue)
	activateJob (\ILIAS\Cron\CronJob $job, \DateTimeImmutable $when, \ilObjUser $actor, bool $wasManuallyExecuted=false)
	deactivateJob (\ILIAS\Cron\CronJob $job, \DateTimeImmutable $when, \ilObjUser $actor, bool $wasManuallyExecuted=false)
	findAll ()

Detailed Description

Definition at line 25 of file JobRepository.php.

Member Function Documentation

activateJob()

ILIAS\BackgroundTasks\Task\Job\JobRepository::activateJob	(	\ILIAS\Cron\CronJob	$job,
		\DateTimeImmutable	$when,
		\ilObjUser	$actor,
		bool	$wasManuallyExecuted = false
	)

createDefaultEntry()

ILIAS\BackgroundTasks\Task\Job\JobRepository::createDefaultEntry	(	\ILIAS\Cron\CronJob	$job,
		string	$component,
		string	$class,
		?string	$path
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

deactivateJob()

ILIAS\BackgroundTasks\Task\Job\JobRepository::deactivateJob	(	\ILIAS\Cron\CronJob	$job,
		\DateTimeImmutable	$when,
		\ilObjUser	$actor,
		bool	$wasManuallyExecuted = false
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

findAll()

ILIAS\BackgroundTasks\Task\Job\JobRepository::findAll

(

)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

getCronJobData()

ILIAS\BackgroundTasks\Task\Job\JobRepository::getCronJobData	(		$id = null,
		bool	$withInactiveJobsIncluded = true
	)

Get cron job configuration/execution data.

Parameters

list<string>|string|null

$id

Returns

list<array<string, mixed>>

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

getJobInstance()

ILIAS\BackgroundTasks\Task\Job\JobRepository::getJobInstance	(	string	$a_id,
		string	$a_component,
		string	$a_class,
		bool	$isCreationContext = false
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

getJobInstanceById()

ILIAS\BackgroundTasks\Task\Job\JobRepository::getJobInstanceById

(

string

$id

)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

getPluginJobs()

ILIAS\BackgroundTasks\Task\Job\JobRepository::getPluginJobs

(

bool

$withOnlyActive = false

)

Returns

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

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

registerJob()

ILIAS\BackgroundTasks\Task\Job\JobRepository::registerJob	(	string	$a_component,
		string	$a_id,
		string	$a_class,
		?string	$a_path
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

resetJob()

ILIAS\BackgroundTasks\Task\Job\JobRepository::resetJob

(

\ILIAS\Cron\CronJob

$job

)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

unregisterJob()

ILIAS\BackgroundTasks\Task\Job\JobRepository::unregisterJob	(	string	$a_component,
		array	$a_xml_job_ids
	)

Parameters

list<string>

$a_xml_job_ids

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

updateJobResult()

ILIAS\BackgroundTasks\Task\Job\JobRepository::updateJobResult	(	\ILIAS\Cron\CronJob	$job,
		\DateTimeImmutable	$when,
		\ilObjUser	$actor,
		JobResult	$result,
		bool	$wasManualExecution = false
	)

updateJobSchedule()

ILIAS\BackgroundTasks\Task\Job\JobRepository::updateJobSchedule	(	\ILIAS\Cron\CronJob	$job,
		?JobScheduleType	$scheduleType,
		?int	$scheduleValue
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

updateRunInformation()

ILIAS\BackgroundTasks\Task\Job\JobRepository::updateRunInformation	(	string	$jobId,
		int	$runningTimestamp,
		int	$aliveTimestamp
	)

Implemented in ILIAS\BackgroundTasks\Task\Job\Repository\JobRepositoryImpl.

---

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

• components/ILIAS/Cron/src/Job/JobRepository.php