class.ilCronJobEntity.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2020 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCronJobEntity
{
    private $job;
    private $isPlugin;

    private $jobId;
    private $component;
    private $scheduleType;
    private $scheduleValue;
    private $jobStatus;
    private $jobStatusUsrId;
    private $jobStatusType;
    private $jobStatusTimestamp;
    private $jobResultStatus;
    private $jobResultUsrId;
    private $jobResultCode;
    private $jobResultMessage;
    private $jobResultType;
    private $jobResultTimestamp;
    private $class;
    private $path;
    private $runningTimestamp;
    private $jobResultDuration;
    private $aliveTimestamp;

    public function __construct(ilCronJob $job, array $record, bool $isPlugin = false)
    {
        $this->job = $job;
        $this->isPlugin = $isPlugin;
        $this->mapRecord($record);
    }

    private function mapRecord(array $record) : void
    {
        $this->jobId = (string) $record['job_id'];
        $this->component = (string) $record['component'];
        $this->scheduleType = (int) $record['schedule_type'];
        $this->scheduleValue = (int) $record['schedule_value'];
        $this->jobStatus = (int) $record['job_status'];
        $this->jobStatusUsrId = (int) $record['job_status_user_id'];
        $this->jobStatusType = (int) $record['job_status_type'];
        $this->jobStatusTimestamp = (int) $record['job_status_ts'];
        $this->jobResultStatus = (int) $record['job_result_status'];
        $this->jobResultUsrId = (int) $record['job_result_user_id'];
        $this->jobResultCode = (string) $record['job_result_code'];
        $this->jobResultMessage = (string) $record['job_result_message'];
        $this->jobResultType = (int) $record['job_result_type'];
        $this->jobResultTimestamp = (int) $record['job_result_ts'];
        $this->class = (string) $record['class'];
        $this->path = (string) $record['path'];
        $this->runningTimestamp = (int) $record['running_ts'];
        $this->jobResultDuration = (int) $record['job_result_dur'];
        $this->aliveTimestamp = (int) $record['alive_ts'];
    }

    public function getJob() : ilCronJob
    {
        return $this->job;
    }

    public function getJobId() : string
    {
        return $this->jobId;
    }

    public function getComponent() : string
    {
        return $this->component;
    }

    public function getScheduleType() : int
    {
        return $this->scheduleType;
    }

    public function getScheduleValue() : int
    {
        return $this->scheduleValue;
    }

    public function getJobStatus() : int
    {
        return $this->jobStatus;
    }

    public function getJobStatusUsrId() : int
    {
        return $this->jobStatusUsrId;
    }

    public function getJobStatusType() : int
    {
        return $this->jobStatusType;
    }

    public function getJobStatusTimestamp() : int
    {
        return $this->jobStatusTimestamp;
    }

    public function getJobResultStatus() : int
    {
        return $this->jobResultStatus;
    }

    public function getJobResultUsrId() : int
    {
        return $this->jobResultUsrId;
    }

    public function getJobResultCode() : string
    {
        return $this->jobResultCode;
    }

    public function getJobResultMessage() : string
    {
        return $this->jobResultMessage;
    }

    public function getJobResultType() : int
    {
        return $this->jobResultType;
    }

    public function getJobResultTimestamp() : int
    {
        return $this->jobResultTimestamp;
    }

    public function getClass() : string
    {
        return $this->class;
    }

    public function getPath() : string
    {
        return $this->path;
    }

    public function getRunningTimestamp() : int
    {
        return $this->runningTimestamp;
    }

    public function getJobResultDuration() : int
    {
        return $this->jobResultDuration;
    }

    public function getAliveTimestamp() : int
    {
        return $this->aliveTimestamp;
    }

    public function isPlugin() : bool
    {
        return $this->isPlugin;
    }

    public function getEffectiveScheduleType() : int
    {
        $type = $this->getScheduleType();
        if (!$this->getJob()->hasFlexibleSchedule() || !$type) {
            $type = (int) $this->getJob()->getDefaultScheduleType();
        }

        return $type;
    }

    public function getEffectiveScheduleValue() : int
    {
        $type = $this->getScheduleType();
        $value = $this->getScheduleValue();
        if (!$this->getJob()->hasFlexibleSchedule() || !$type) {
            $value = (int) $this->getJob()->getDefaultScheduleValue();
        }

        return $value;
    }

    public function getEffectiveTitle() : string
    {
        $id = $this->getJobId();
        if ($this->isPlugin()) {
            $id = 'pl__' . $this->getComponent() . '__' . $id;
        }

        $title = (string) $this->getJob()->getTitle();
        if (0 === strlen($title)) {
            $title = $id;
        }

        return $title;
    }
}