Collaboration diagram for ILIAS\Cron\Job\JobEntity:

Public Member Functions
	__construct (private readonly \ILIAS\Cron\CronJob $job, array $record, private readonly bool $isPlugin=false)

	getJob ()

	getJobId ()

	getEffectiveJobId ()

	getComponent ()

	getScheduleType ()

	getScheduleValue ()

	getJobStatus ()

	getJobStatusUsrId ()

	getJobStatusType ()

	getJobStatusTimestamp ()

	getJobResultStatus ()

	getJobResultUsrId ()

	getJobResultCode ()

	getJobResultMessage ()

	getJobResultType ()

	getJobResultTimestamp ()

	getClass ()

	getPath ()

	getRunningTimestamp ()

	getJobResultDuration ()

	getAliveTimestamp ()

	isPlugin ()

	getEffectiveScheduleType ()

	getEffectiveScheduleValue ()

	getEffectiveTitle ()

Private Member Functions
	mapRecord (array $record)

Private Attributes
string	$job_id

string	$component

JobScheduleType	$schedule_type

int	$schedule_value

int	$job_status

int	$job_status_usr_id

int	$job_status_type

int	$job_status_timestamp

int	$job_result_status

int	$job_result_usr_id

string	$job_result_code

string	$job_result_message

int	$job_result_type

int	$job_result_timestamp

string	$class

string	$path

int	$running_timestamp

int	$job_result_duration

int	$alive_timestamp

Detailed Description

Definition at line 25 of file JobEntity.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Cron\Job\JobEntity::__construct	(	private readonly \ILIAS\Cron\CronJob	$job,
		array	$record,
		private readonly bool	$isPlugin = `false`
	)

Parameters

array<string,mixed> $record

Definition at line 50 of file JobEntity.php.

      {
        $this->mapRecord($record);
    }

References ILIAS\Cron\Job\JobEntity\mapRecord().

Here is the call graph for this function:

Member Function Documentation

◆ getAliveTimestamp()

ILIAS\Cron\Job\JobEntity::getAliveTimestamp ( )

Definition at line 191 of file JobEntity.php.

                                       : int
    {
        return $this->alive_timestamp;
    }

References ILIAS\Cron\Job\JobEntity\$alive_timestamp.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatLastRun().

Here is the caller graph for this function:

◆ getClass()

ILIAS\Cron\Job\JobEntity::getClass ( )

Definition at line 171 of file JobEntity.php.

                              : string
    {
        return $this->class;
    }

References ILIAS\Cron\Job\JobEntity\$class.

◆ getComponent()

ILIAS\Cron\Job\JobEntity::getComponent ( )

Definition at line 106 of file JobEntity.php.

                                  : string
    {
        return $this->component;
    }

References ILIAS\Cron\Job\JobEntity\$component.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filter(), ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), ILIAS\Cron\Job\Manager\UI\JobTable\formatComponent(), ILIAS\Cron\Job\JobEntity\getEffectiveJobId(), and ILIAS\Cron\Job\JobEntity\getEffectiveTitle().

Here is the caller graph for this function:

◆ getEffectiveJobId()

ILIAS\Cron\Job\JobEntity::getEffectiveJobId ( )

Definition at line 96 of file JobEntity.php.

                                       : string
    {
        $job_id = $this->getJobId();
        if ($this->isPlugin()) {
            $job_id = 'pl__' . $this->getComponent() . '__' . $job_id;
        }
 
        return $job_id;
    }

References ILIAS\Cron\Job\JobEntity\$job_id, ILIAS\Cron\Job\JobEntity\getComponent(), ILIAS\Cron\Job\JobEntity\getJobId(), and ILIAS\Cron\Job\JobEntity\isPlugin().

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatTitle(), and ilObjCronGUI\retrieveTableActionJobIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveScheduleType()

ILIAS\Cron\Job\JobEntity::getEffectiveScheduleType ( )

Definition at line 201 of file JobEntity.php.

                                              : JobScheduleType
    {
        $type = $this->getScheduleType();
        if (!$type || !$this->getJob()->hasFlexibleSchedule()) {
            $type = $this->getJob()->getDefaultScheduleType();
        }
 
        return $type;
    }

References ILIAS\Cron\Job\JobEntity\getJob(), and ILIAS\Cron\Job\JobEntity\getScheduleType().

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), and ILIAS\Cron\Job\Manager\UI\JobTable\formatSchedule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveScheduleValue()

ILIAS\Cron\Job\JobEntity::getEffectiveScheduleValue ( )

Definition at line 211 of file JobEntity.php.

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

References ILIAS\Cron\Job\JobEntity\getJob(), ILIAS\Cron\Job\JobEntity\getScheduleType(), ILIAS\Cron\Job\JobEntity\getScheduleValue(), and ILIAS\Repository\int().

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatSchedule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveTitle()

ILIAS\Cron\Job\JobEntity::getEffectiveTitle ( )

Definition at line 222 of file JobEntity.php.

                                       : string
    {
        $id = $this->getJobId();
        if ($this->isPlugin()) {
            $id = 'pl__' . $this->getComponent() . '__' . $id;
        }
 
        $title = $this->getJob()->getTitle();
        if ($title === '') {
            $title = $id;
        }
 
        return $title;
    }

References $id, ILIAS\Cron\Job\JobEntity\getComponent(), ILIAS\Cron\Job\JobEntity\getJob(), ILIAS\Cron\Job\JobEntity\getJobId(), and ILIAS\Cron\Job\JobEntity\isPlugin().

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), and ILIAS\Cron\Job\Manager\UI\JobTable\formatTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJob()

ILIAS\Cron\Job\JobEntity::getJob ( )

Definition at line 86 of file JobEntity.php.

                            : \ILIAS\Cron\CronJob
    {
        return $this->job;
    }

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), ILIAS\Cron\Job\Manager\UI\JobTable\formatTitle(), ILIAS\Cron\Job\JobEntity\getEffectiveScheduleType(), ILIAS\Cron\Job\JobEntity\getEffectiveScheduleValue(), and ILIAS\Cron\Job\JobEntity\getEffectiveTitle().

Here is the caller graph for this function:

◆ getJobId()

ILIAS\Cron\Job\JobEntity::getJobId ( )

Definition at line 91 of file JobEntity.php.

                              : string
    {
        return $this->job_id;
    }

References ILIAS\Cron\Job\JobEntity\$job_id.

Referenced by ILIAS\Cron\Job\JobEntity\getEffectiveJobId(), ILIAS\Cron\Job\JobEntity\getEffectiveTitle(), and CronJobEntityTest\testCollectionCanBeFilteredAndSliced().

Here is the caller graph for this function:

◆ getJobResultCode()

ILIAS\Cron\Job\JobEntity::getJobResultCode ( )

Definition at line 151 of file JobEntity.php.

                                      : string
    {
        return $this->job_result_code;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_code.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

Here is the caller graph for this function:

◆ getJobResultDuration()

ILIAS\Cron\Job\JobEntity::getJobResultDuration ( )

Definition at line 186 of file JobEntity.php.

                                          : int
    {
        return $this->job_result_duration;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_duration.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

Here is the caller graph for this function:

◆ getJobResultMessage()

ILIAS\Cron\Job\JobEntity::getJobResultMessage ( )

Definition at line 156 of file JobEntity.php.

                                         : string
    {
        return $this->job_result_message;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_message.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

Here is the caller graph for this function:

◆ getJobResultStatus()

ILIAS\Cron\Job\JobEntity::getJobResultStatus ( )

Definition at line 141 of file JobEntity.php.

                                        : int
    {
        return $this->job_result_status;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_status.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), and ILIAS\Cron\Job\Manager\UI\JobTable\formatResult().

Here is the caller graph for this function:

◆ getJobResultTimestamp()

ILIAS\Cron\Job\JobEntity::getJobResultTimestamp ( )

Definition at line 166 of file JobEntity.php.

                                           : int
    {
        return $this->job_result_timestamp;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_timestamp.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatLastRun(), and ILIAS\Cron\Job\Manager\UI\JobTable\getRecords().

Here is the caller graph for this function:

◆ getJobResultType()

ILIAS\Cron\Job\JobEntity::getJobResultType ( )

Definition at line 161 of file JobEntity.php.

                                      : int
    {
        return $this->job_result_type;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_type.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

Here is the caller graph for this function:

◆ getJobResultUsrId()

ILIAS\Cron\Job\JobEntity::getJobResultUsrId ( )

Definition at line 146 of file JobEntity.php.

                                       : int
    {
        return $this->job_result_usr_id;
    }

References ILIAS\Cron\Job\JobEntity\$job_result_usr_id.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

Here is the caller graph for this function:

◆ getJobStatus()

ILIAS\Cron\Job\JobEntity::getJobStatus ( )

Definition at line 121 of file JobEntity.php.

                                  : int
    {
        return $this->job_status;
    }

References ILIAS\Cron\Job\JobEntity\$job_status.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs().

Here is the caller graph for this function:

◆ getJobStatusTimestamp()

ILIAS\Cron\Job\JobEntity::getJobStatusTimestamp ( )

Definition at line 136 of file JobEntity.php.

                                           : int
    {
        return $this->job_status_timestamp;
    }

References ILIAS\Cron\Job\JobEntity\$job_status_timestamp.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatStatusInfo().

Here is the caller graph for this function:

◆ getJobStatusType()

ILIAS\Cron\Job\JobEntity::getJobStatusType ( )

Definition at line 131 of file JobEntity.php.

                                      : int
    {
        return $this->job_status_type;
    }

References ILIAS\Cron\Job\JobEntity\$job_status_type.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatStatusInfo().

Here is the caller graph for this function:

◆ getJobStatusUsrId()

ILIAS\Cron\Job\JobEntity::getJobStatusUsrId ( )

Definition at line 126 of file JobEntity.php.

                                       : int
    {
        return $this->job_status_usr_id;
    }

References ILIAS\Cron\Job\JobEntity\$job_status_usr_id.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatStatusInfo().

Here is the caller graph for this function:

◆ getPath()

ILIAS\Cron\Job\JobEntity::getPath ( )

Definition at line 176 of file JobEntity.php.

                             : string
    {
        return $this->path;
    }

References ILIAS\Cron\Job\JobEntity\$path.

◆ getRunningTimestamp()

ILIAS\Cron\Job\JobEntity::getRunningTimestamp ( )

Definition at line 181 of file JobEntity.php.

                                         : int
    {
        return $this->running_timestamp;
    }

References ILIAS\Cron\Job\JobEntity\$running_timestamp.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatLastRun(), and ILIAS\Cron\Job\Manager\UI\JobTable\getRecords().

Here is the caller graph for this function:

◆ getScheduleType()

ILIAS\Cron\Job\JobEntity::getScheduleType ( )

Definition at line 111 of file JobEntity.php.

                                     : ?JobScheduleType
    {
        return $this->schedule_type;
    }

References ILIAS\Cron\Job\JobEntity\$schedule_type.

Referenced by ILIAS\Cron\Job\JobEntity\getEffectiveScheduleType(), and ILIAS\Cron\Job\JobEntity\getEffectiveScheduleValue().

Here is the caller graph for this function:

◆ getScheduleValue()

ILIAS\Cron\Job\JobEntity::getScheduleValue ( )

Definition at line 116 of file JobEntity.php.

                                      : int
    {
        return $this->schedule_value;
    }

References ILIAS\Cron\Job\JobEntity\$schedule_value.

Referenced by ILIAS\Cron\Job\JobEntity\getEffectiveScheduleValue().

Here is the caller graph for this function:

◆ isPlugin()

ILIAS\Cron\Job\JobEntity::isPlugin ( )

Definition at line 196 of file JobEntity.php.

                              : bool
    {
        return $this->isPlugin;
    }

Referenced by ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filter(), ILIAS\Cron\Job\Manager\UI\JobTableFilterMediator\filteredJobs(), ILIAS\Cron\Job\Manager\UI\JobTable\formatComponent(), ILIAS\Cron\Job\JobEntity\getEffectiveJobId(), and ILIAS\Cron\Job\JobEntity\getEffectiveTitle().

Here is the caller graph for this function:

◆ mapRecord()

ILIAS\Cron\Job\JobEntity::mapRecord ( array $record )

private

Parameters

array<string,mixed> $record

Definition at line 61 of file JobEntity.php.

                                             : void
    {
        $this->job_id = (string) $record['job_id'];
        $this->component = (string) $record['component'];
        $this->schedule_type = is_numeric($record['schedule_type']) ? JobScheduleType::tryFrom(
            (int) $record['schedule_type']
        ) : null;
        $this->schedule_value = (int) $record['schedule_value'];
        $this->job_status = (int) $record['job_status'];
        $this->job_status_usr_id = (int) $record['job_status_user_id'];
        $this->job_status_type = (int) $record['job_status_type'];
        $this->job_status_timestamp = (int) $record['job_status_ts'];
        $this->job_result_status = (int) $record['job_result_status'];
        $this->job_result_usr_id = (int) $record['job_result_user_id'];
        $this->job_result_code = (string) $record['job_result_code'];
        $this->job_result_message = (string) $record['job_result_message'];
        $this->job_result_type = (int) $record['job_result_type'];
        $this->job_result_timestamp = (int) $record['job_result_ts'];
        $this->class = (string) $record['class'];
        $this->path = (string) $record['path'];
        $this->running_timestamp = (int) $record['running_ts'];
        $this->job_result_duration = (int) $record['job_result_dur'];
        $this->alive_timestamp = (int) $record['alive_ts'];
    }

References ILIAS\Repository\int().

Referenced by ILIAS\Cron\Job\JobEntity\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $alive_timestamp

int ILIAS\Cron\Job\JobEntity::$alive_timestamp

private

Definition at line 45 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getAliveTimestamp().

◆ $class

string ILIAS\Cron\Job\JobEntity::$class

private

Definition at line 41 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getClass().

◆ $component

string ILIAS\Cron\Job\JobEntity::$component

private

Definition at line 28 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getComponent().

◆ $job_id

string ILIAS\Cron\Job\JobEntity::$job_id

private

Definition at line 27 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getEffectiveJobId(), and ILIAS\Cron\Job\JobEntity\getJobId().

◆ $job_result_code

string ILIAS\Cron\Job\JobEntity::$job_result_code

private

Definition at line 37 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultCode().

◆ $job_result_duration

int ILIAS\Cron\Job\JobEntity::$job_result_duration

private

Definition at line 44 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultDuration().

◆ $job_result_message

string ILIAS\Cron\Job\JobEntity::$job_result_message

private

Definition at line 38 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultMessage().

◆ $job_result_status

int ILIAS\Cron\Job\JobEntity::$job_result_status

private

Definition at line 35 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultStatus().

◆ $job_result_timestamp

int ILIAS\Cron\Job\JobEntity::$job_result_timestamp

private

Definition at line 40 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultTimestamp().

◆ $job_result_type

int ILIAS\Cron\Job\JobEntity::$job_result_type

private

Definition at line 39 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultType().

◆ $job_result_usr_id

int ILIAS\Cron\Job\JobEntity::$job_result_usr_id

private

Definition at line 36 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobResultUsrId().

◆ $job_status

int ILIAS\Cron\Job\JobEntity::$job_status

private

Definition at line 31 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobStatus().

◆ $job_status_timestamp

int ILIAS\Cron\Job\JobEntity::$job_status_timestamp

private

Definition at line 34 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobStatusTimestamp().

◆ $job_status_type

int ILIAS\Cron\Job\JobEntity::$job_status_type

private

Definition at line 33 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobStatusType().

◆ $job_status_usr_id

int ILIAS\Cron\Job\JobEntity::$job_status_usr_id

private

Definition at line 32 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getJobStatusUsrId().

◆ $path

string ILIAS\Cron\Job\JobEntity::$path

private

Definition at line 42 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getPath().

◆ $running_timestamp

int ILIAS\Cron\Job\JobEntity::$running_timestamp

private

Definition at line 43 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getRunningTimestamp().

◆ $schedule_type

JobScheduleType ILIAS\Cron\Job\JobEntity::$schedule_type

private

Definition at line 29 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getScheduleType().

◆ $schedule_value

int ILIAS\Cron\Job\JobEntity::$schedule_value

private

Definition at line 30 of file JobEntity.php.

Referenced by ILIAS\Cron\Job\JobEntity\getScheduleValue().

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

components/ILIAS/Cron/src/Job/JobEntity.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAliveTimestamp()

◆ getClass()

◆ getComponent()

◆ getEffectiveJobId()

◆ getEffectiveScheduleType()

◆ getEffectiveScheduleValue()

◆ getEffectiveTitle()

◆ getJob()

◆ getJobId()

◆ getJobResultCode()

◆ getJobResultDuration()

◆ getJobResultMessage()

◆ getJobResultStatus()

◆ getJobResultTimestamp()

◆ getJobResultType()

◆ getJobResultUsrId()

◆ getJobStatus()

◆ getJobStatusTimestamp()

◆ getJobStatusType()

◆ getJobStatusUsrId()

◆ getPath()

◆ getRunningTimestamp()

◆ getScheduleType()

◆ getScheduleValue()

◆ isPlugin()

◆ mapRecord()

Field Documentation

◆ $alive_timestamp

◆ $class

◆ $component

◆ $job_id

◆ $job_result_code

◆ $job_result_duration

◆ $job_result_message

◆ $job_result_status

◆ $job_result_timestamp

◆ $job_result_type

◆ $job_result_usr_id

◆ $job_status

◆ $job_status_timestamp

◆ $job_status_type

◆ $job_status_usr_id

◆ $path

◆ $running_timestamp

◆ $schedule_type

◆ $schedule_value