Collaboration diagram for ilCronJobEntity:

Public Member Functions
	__construct (ilCronJob $job, array $record, 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
ilCronJob	$job

bool	$isPlugin

string	$jobId

string	$component

int	$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 21 of file class.ilCronJobEntity.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilCronJobEntity constructor.

Parameters

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

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

References $isPlugin, $job, isPlugin(), and mapRecord().

     {
         $this->job = $job;
         $this->isPlugin = $isPlugin;
         $this->mapRecord($record);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAliveTimestamp()

ilCronJobEntity::getAliveTimestamp ( )

Definition at line 179 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 159 of file class.ilCronJobEntity.php.

References $class.

                               : string
     {
         return $this->class;
     }

◆ getComponent()

ilCronJobEntity::getComponent ( )

Definition at line 94 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 189 of file class.ilCronJobEntity.php.

References $type, getJob(), and getScheduleType().

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

                                               : int
     {
         $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 199 of file class.ilCronJobEntity.php.

References $type, 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 210 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 84 of file class.ilCronJobEntity.php.

References $job.

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 89 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 139 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 174 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 144 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 129 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 154 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 149 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 134 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 109 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 124 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 119 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 114 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 164 of file class.ilCronJobEntity.php.

References $path.

                              : string
     {
         return $this->path;
     }

◆ getRunningTimestamp()

ilCronJobEntity::getRunningTimestamp ( )

Definition at line 169 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 99 of file class.ilCronJobEntity.php.

References $scheduleType.

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

                                      : int
     {
         return $this->scheduleType;
     }

Here is the caller graph for this function:

◆ getScheduleValue()

ilCronJobEntity::getScheduleValue ( )

Definition at line 104 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 184 of file class.ilCronJobEntity.php.

References $isPlugin.

Referenced by __construct(), 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 61 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 = (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'];
     }

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().

◆ $isPlugin

bool ilCronJobEntity::$isPlugin

private

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

Referenced by __construct(), and isPlugin().

◆ $job

ilCronJob ilCronJobEntity::$job

private

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

Referenced by __construct(), and getJob().

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

int 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

◆ $isPlugin

◆ $job

◆ $jobId

◆ $jobResultCode

◆ $jobResultDuration

◆ $jobResultMessage

◆ $jobResultStatus

◆ $jobResultTimestamp

◆ $jobResultType

◆ $jobResultUsrId

◆ $jobStatus

◆ $jobStatusTimestamp

◆ $jobStatusType

◆ $jobStatusUsrId

◆ $path

◆ $runningTimestamp

◆ $scheduleType

◆ $scheduleValue