interface.ilCronJobRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Cron\Schedule\CronJobScheduleType;

interface ilCronJobRepository
{
    public function getJobInstanceById(string $id): ?ilCronJob;

    public function getJobInstance(
        string $a_id,
        string $a_component,
        string $a_class,
        bool $isCreationContext = false
    ): ?ilCronJob;

    public function getCronJobData($id = null, bool $withInactiveJobsIncluded = true): array;

    public function registerJob(string $a_component, string $a_id, string $a_class, ?string $a_path): void;

    public function unregisterJob(string $a_component, array $a_xml_job_ids): void;

    public function createDefaultEntry(ilCronJob $job, string $component, string $class, ?string $path): void;

    public function getPluginJobs(bool $withOnlyActive = false): array;

    public function resetJob(ilCronJob $job): void;

    public function updateJobResult(
        ilCronJob $job,
        DateTimeImmutable $when,
        ilObjUser $actor,
        ilCronJobResult $result,
        bool $wasManualExecution = false
    ): void;

    public function updateRunInformation(string $jobId, int $runningTimestamp, int $aliveTimestamp): void;

    public function updateJobSchedule(ilCronJob $job, ?CronJobScheduleType $scheduleType, ?int $scheduleValue): void;

    public function activateJob(ilCronJob $job, DateTimeImmutable $when, ilObjUser $actor, bool $wasManuallyExecuted = false): void;

    public function deactivateJob(ilCronJob $job, DateTimeImmutable $when, ilObjUser $actor, bool $wasManuallyExecuted = false): void;

    public function findAll(): ilCronJobCollection;
}