JobRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Cron\Job;

use ILIAS\Cron\Job\Schedule\JobScheduleType;

interface JobRepository
{
    public function getJobInstanceById(string $id): ?\ILIAS\Cron\CronJob;

    public function getJobInstance(
        string $a_id,
        string $a_component,
        string $a_class,
        bool $isCreationContext = false
    ): ?\ILIAS\Cron\CronJob;

    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(\ILIAS\Cron\CronJob $job, string $component, string $class, ?string $path): void;

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

    public function resetJob(\ILIAS\Cron\CronJob $job): void;

    public function updateJobResult(
        \ILIAS\Cron\CronJob $job,
        \DateTimeImmutable $when,
        \ilObjUser $actor,
        JobResult $result,
        bool $wasManualExecution = false
    ): void;

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

    public function updateJobSchedule(\ILIAS\Cron\CronJob $job, ?JobScheduleType $scheduleType, ?int $scheduleValue): void;

    public function activateJob(
        \ILIAS\Cron\CronJob $job,
        \DateTimeImmutable $when,
        \ilObjUser $actor,
        bool $wasManuallyExecuted = false
    ): void;

    public function deactivateJob(
        \ILIAS\Cron\CronJob $job,
        \DateTimeImmutable $when,
        \ilObjUser $actor,
        bool $wasManuallyExecuted = false
    ): void;

    public function findAll(): JobCollection;
}