Collaboration diagram for ilCronJobEntity:

Public Member Functions
	__construct (private readonly ilCronJob $job, array $record, private readonly bool $isPlugin=false)
	ilCronJobEntity constructor. More...

	getJob ()

	getJobId ()

	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	$jobId

string	$component

CronJobScheduleType	$scheduleType

int	$scheduleValue

int	$jobStatus

int	$jobStatusUsrId

int	$jobStatusType

int	$jobStatusTimestamp

int	$jobResultStatus

int	$jobResultUsrId

string	$jobResultCode

string	$jobResultMessage

int	$jobResultType

int	$jobResultTimestamp

string	$class

string	$path

int	$runningTimestamp

int	$jobResultDuration

int	$aliveTimestamp

Detailed Description

Definition at line 23 of file class.ilCronJobEntity.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronJobEntity::__construct	(	private readonly ilCronJob	$job,
		array	$record,
		private readonly bool	$isPlugin = `false`
	)

ilCronJobEntity constructor.

Parameters

ilCronJob	$job
	array<string,mixed>	$record
bool	$isPlugin

Definition at line 51 of file class.ilCronJobEntity.php.

References mapRecord().

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

Here is the call graph for this function:

Member Function Documentation

◆ getAliveTimestamp()

ilCronJobEntity::getAliveTimestamp ( )

Definition at line 177 of file class.ilCronJobEntity.php.

References $aliveTimestamp.

Referenced by ilCronManagerTableGUI\populate().

                                        : int
     {
         return $this->aliveTimestamp;
     }

Here is the caller graph for this function:

◆ getClass()

ilCronJobEntity::getClass ( )

Definition at line 157 of file class.ilCronJobEntity.php.

References $class.

                               : string
     {
         return $this->class;
     }

◆ getComponent()

ilCronJobEntity::getComponent ( )

Definition at line 92 of file class.ilCronJobEntity.php.

References $component.

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableFilterMediator\filteredJobs(), getEffectiveTitle(), and ilCronManagerTableGUI\populate().

                                   : string
     {
         return $this->component;
     }

Here is the caller graph for this function:

◆ getEffectiveScheduleType()

ilCronJobEntity::getEffectiveScheduleType ( )

Definition at line 187 of file class.ilCronJobEntity.php.

References getJob(), and getScheduleType().

Referenced by ilCronManagerTableFilterMediator\filteredJobs(), ilCronManagerTableGUI\formatSchedule(), and ilCronManagerTableGUI\populate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveScheduleValue()

ilCronJobEntity::getEffectiveScheduleValue ( )

Definition at line 197 of file class.ilCronJobEntity.php.

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

Referenced by ilCronManagerTableGUI\formatSchedule(), and ilCronManagerTableGUI\populate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveTitle()

ilCronJobEntity::getEffectiveTitle ( )

Definition at line 208 of file class.ilCronJobEntity.php.

References $id, getComponent(), getJob(), getJobId(), and isPlugin().

Referenced by ilCronManagerTableFilterMediator\filteredJobs(), and ilCronManagerTableGUI\populate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJob()

ilCronJobEntity::getJob ( )

Definition at line 82 of file class.ilCronJobEntity.php.

Referenced by getEffectiveScheduleType(), getEffectiveScheduleValue(), getEffectiveTitle(), and ilCronManagerTableGUI\populate().

                             : ilCronJob
     {
         return $this->job;
     }

Here is the caller graph for this function:

◆ getJobId()

ilCronJobEntity::getJobId ( )

Definition at line 87 of file class.ilCronJobEntity.php.

References $jobId.

Referenced by getEffectiveTitle(), ilCronManagerTableGUI\populate(), and CronJobEntityTest\testCollectionCanBeFilteredAndSliced().

                               : string
     {
         return $this->jobId;
     }

Here is the caller graph for this function:

◆ getJobResultCode()

ilCronJobEntity::getJobResultCode ( )

Definition at line 137 of file class.ilCronJobEntity.php.

References $jobResultCode.

Referenced by ilCronManagerTableGUI\formatResultInfo().

                                       : string
     {
         return $this->jobResultCode;
     }

Here is the caller graph for this function:

◆ getJobResultDuration()

ilCronJobEntity::getJobResultDuration ( )

Definition at line 172 of file class.ilCronJobEntity.php.

References $jobResultDuration.

Referenced by ilCronManagerTableGUI\formatResultInfo().

                                           : int
     {
         return $this->jobResultDuration;
     }

Here is the caller graph for this function:

◆ getJobResultMessage()

ilCronJobEntity::getJobResultMessage ( )

Definition at line 142 of file class.ilCronJobEntity.php.

References $jobResultMessage.

Referenced by ilCronManagerTableGUI\formatResultInfo().

                                          : string
     {
         return $this->jobResultMessage;
     }

Here is the caller graph for this function:

◆ getJobResultStatus()

ilCronJobEntity::getJobResultStatus ( )

Definition at line 127 of file class.ilCronJobEntity.php.

References $jobResultStatus.

Referenced by ilCronManagerTableFilterMediator\filteredJobs(), ilCronManagerTableGUI\formatResult(), and ilCronManagerTableGUI\populate().

                                         : int
     {
         return $this->jobResultStatus;
     }

Here is the caller graph for this function:

◆ getJobResultTimestamp()

ilCronJobEntity::getJobResultTimestamp ( )

Definition at line 152 of file class.ilCronJobEntity.php.

References $jobResultTimestamp.

Referenced by ilCronManagerTableGUI\populate().

                                            : int
     {
         return $this->jobResultTimestamp;
     }

Here is the caller graph for this function:

◆ getJobResultType()

ilCronJobEntity::getJobResultType ( )

Definition at line 147 of file class.ilCronJobEntity.php.

References $jobResultType.

Referenced by ilCronManagerTableGUI\formatResultInfo().

                                       : int
     {
         return $this->jobResultType;
     }

Here is the caller graph for this function:

◆ getJobResultUsrId()

ilCronJobEntity::getJobResultUsrId ( )

Definition at line 132 of file class.ilCronJobEntity.php.

References $jobResultUsrId.

Referenced by ilCronManagerTableGUI\formatResultInfo().

                                        : int
     {
         return $this->jobResultUsrId;
     }

Here is the caller graph for this function:

◆ getJobStatus()

ilCronJobEntity::getJobStatus ( )

Definition at line 107 of file class.ilCronJobEntity.php.

References $jobStatus.

Referenced by ilCronManagerTableFilterMediator\filteredJobs(), and ilCronManagerTableGUI\populate().

                                   : int
     {
         return $this->jobStatus;
     }

Here is the caller graph for this function:

◆ getJobStatusTimestamp()

ilCronJobEntity::getJobStatusTimestamp ( )

Definition at line 122 of file class.ilCronJobEntity.php.

References $jobStatusTimestamp.

Referenced by ilCronManagerTableGUI\formatStatusInfo().

                                            : int
     {
         return $this->jobStatusTimestamp;
     }

Here is the caller graph for this function:

◆ getJobStatusType()

ilCronJobEntity::getJobStatusType ( )

Definition at line 117 of file class.ilCronJobEntity.php.

References $jobStatusType.

Referenced by ilCronManagerTableGUI\formatStatusInfo().

                                       : int
     {
         return $this->jobStatusType;
     }

Here is the caller graph for this function:

◆ getJobStatusUsrId()

ilCronJobEntity::getJobStatusUsrId ( )

Definition at line 112 of file class.ilCronJobEntity.php.

References $jobStatusUsrId.

Referenced by ilCronManagerTableGUI\formatStatusInfo().

                                        : int
     {
         return $this->jobStatusUsrId;
     }

Here is the caller graph for this function:

◆ getPath()

ilCronJobEntity::getPath ( )

Definition at line 162 of file class.ilCronJobEntity.php.

References $path.

                              : string
     {
         return $this->path;
     }

◆ getRunningTimestamp()

ilCronJobEntity::getRunningTimestamp ( )

Definition at line 167 of file class.ilCronJobEntity.php.

References $runningTimestamp.

Referenced by ilCronManagerTableGUI\populate().

                                          : int
     {
         return $this->runningTimestamp;
     }

Here is the caller graph for this function:

◆ getScheduleType()

ilCronJobEntity::getScheduleType ( )

Definition at line 97 of file class.ilCronJobEntity.php.

References $scheduleType.

Referenced by getEffectiveScheduleType(), getEffectiveScheduleValue(), and ilCronManagerTableGUI\populate().

                                      : ?CronJobScheduleType
     {
         return $this->scheduleType;
     }

Here is the caller graph for this function:

◆ getScheduleValue()

ilCronJobEntity::getScheduleValue ( )

Definition at line 102 of file class.ilCronJobEntity.php.

References $scheduleValue.

Referenced by getEffectiveScheduleValue().

                                       : int
     {
         return $this->scheduleValue;
     }

Here is the caller graph for this function:

◆ isPlugin()

ilCronJobEntity::isPlugin ( )

Definition at line 182 of file class.ilCronJobEntity.php.

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableFilterMediator\filteredJobs(), getEffectiveTitle(), and ilCronManagerTableGUI\populate().

                               : bool
     {
         return $this->isPlugin;
     }

Here is the caller graph for this function:

◆ mapRecord()

ilCronJobEntity::mapRecord ( array $record )

private

Parameters

array<string,mixed> $record

Definition at line 59 of file class.ilCronJobEntity.php.

References ILIAS\Repository\int().

Referenced by __construct().

                                              : void
     {
         $this->jobId = (string) $record['job_id'];
         $this->component = (string) $record['component'];
         $this->scheduleType = is_numeric($record['schedule_type']) ? CronJobScheduleType::tryFrom((int) $record['schedule_type']) : null;
         $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'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $aliveTimestamp

int ilCronJobEntity::$aliveTimestamp

private

Definition at line 43 of file class.ilCronJobEntity.php.

Referenced by getAliveTimestamp().

◆ $class

string ilCronJobEntity::$class

private

Definition at line 39 of file class.ilCronJobEntity.php.

Referenced by getClass().

◆ $component

string ilCronJobEntity::$component

private

Definition at line 26 of file class.ilCronJobEntity.php.

Referenced by getComponent().

◆ $jobId

string ilCronJobEntity::$jobId

private

Definition at line 25 of file class.ilCronJobEntity.php.

Referenced by getJobId().

◆ $jobResultCode

string ilCronJobEntity::$jobResultCode

private

Definition at line 35 of file class.ilCronJobEntity.php.

Referenced by getJobResultCode().

◆ $jobResultDuration

int ilCronJobEntity::$jobResultDuration

private

Definition at line 42 of file class.ilCronJobEntity.php.

Referenced by getJobResultDuration().

◆ $jobResultMessage

string ilCronJobEntity::$jobResultMessage

private

Definition at line 36 of file class.ilCronJobEntity.php.

Referenced by getJobResultMessage().

◆ $jobResultStatus

int ilCronJobEntity::$jobResultStatus

private

Definition at line 33 of file class.ilCronJobEntity.php.

Referenced by getJobResultStatus().

◆ $jobResultTimestamp

int ilCronJobEntity::$jobResultTimestamp

private

Definition at line 38 of file class.ilCronJobEntity.php.

Referenced by getJobResultTimestamp().

◆ $jobResultType

int ilCronJobEntity::$jobResultType

private

Definition at line 37 of file class.ilCronJobEntity.php.

Referenced by getJobResultType().

◆ $jobResultUsrId

int ilCronJobEntity::$jobResultUsrId

private

Definition at line 34 of file class.ilCronJobEntity.php.

Referenced by getJobResultUsrId().

◆ $jobStatus

int ilCronJobEntity::$jobStatus

private

Definition at line 29 of file class.ilCronJobEntity.php.

Referenced by getJobStatus().

◆ $jobStatusTimestamp

int ilCronJobEntity::$jobStatusTimestamp

private

Definition at line 32 of file class.ilCronJobEntity.php.

Referenced by getJobStatusTimestamp().

◆ $jobStatusType

int ilCronJobEntity::$jobStatusType

private

Definition at line 31 of file class.ilCronJobEntity.php.

Referenced by getJobStatusType().

◆ $jobStatusUsrId

int ilCronJobEntity::$jobStatusUsrId

private

Definition at line 30 of file class.ilCronJobEntity.php.

Referenced by getJobStatusUsrId().

◆ $path

string ilCronJobEntity::$path

private

Definition at line 40 of file class.ilCronJobEntity.php.

Referenced by getPath().

◆ $runningTimestamp

int ilCronJobEntity::$runningTimestamp

private

Definition at line 41 of file class.ilCronJobEntity.php.

Referenced by getRunningTimestamp().

◆ $scheduleType

CronJobScheduleType ilCronJobEntity::$scheduleType

private

Definition at line 27 of file class.ilCronJobEntity.php.

Referenced by getScheduleType().

◆ $scheduleValue

int ilCronJobEntity::$scheduleValue

private

Definition at line 28 of file class.ilCronJobEntity.php.

Referenced by getScheduleValue().

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

Services/Cron/classes/class.ilCronJobEntity.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAliveTimestamp()

◆ getClass()

◆ getComponent()

◆ getEffectiveScheduleType()

◆ getEffectiveScheduleValue()

◆ getEffectiveTitle()

◆ getJob()

◆ getJobId()

◆ getJobResultCode()

◆ getJobResultDuration()

◆ getJobResultMessage()

◆ getJobResultStatus()

◆ getJobResultTimestamp()

◆ getJobResultType()

◆ getJobResultUsrId()

◆ getJobStatus()

◆ getJobStatusTimestamp()

◆ getJobStatusType()

◆ getJobStatusUsrId()

◆ getPath()

◆ getRunningTimestamp()

◆ getScheduleType()

◆ getScheduleValue()

◆ isPlugin()

◆ mapRecord()

Field Documentation

◆ $aliveTimestamp

◆ $class

◆ $component

◆ $jobId

◆ $jobResultCode

◆ $jobResultDuration

◆ $jobResultMessage

◆ $jobResultStatus

◆ $jobResultTimestamp

◆ $jobResultType

◆ $jobResultUsrId

◆ $jobStatus

◆ $jobStatusTimestamp

◆ $jobStatusType

◆ $jobStatusUsrId

◆ $path

◆ $runningTimestamp

◆ $scheduleType

◆ $scheduleValue