ilCronJobEntity Class Reference

Class ilCronJobEntity. More...

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
	$job
	$isPlugin
	$jobId
	$component
	$scheduleType
	$scheduleValue
	$jobStatus
	$jobStatusUsrId
	$jobStatusType
	$jobStatusTimestamp
	$jobResultStatus
	$jobResultUsrId
	$jobResultCode
	$jobResultMessage
	$jobResultType
	$jobResultTimestamp
	$class
	$path
	$runningTimestamp
	$jobResultDuration
	$aliveTimestamp

Detailed Description

Class ilCronJobEntity.

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

Constructor & Destructor Documentation

__construct()

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

ilCronJobEntity constructor.

Parameters

ilCronJob	$job
array	$record
bool	$isPlugin

Definition at line 59 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

(

)

Returns

int

Definition at line 247 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

(

)

Returns

string

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

References $class.

                               : string
    {
        return $this->class;
    }

getComponent()

ilCronJobEntity::getComponent

(

)

Returns

string

Definition at line 111 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

(

)

Returns

int

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

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

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

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

        return $type;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEffectiveScheduleValue()

ilCronJobEntity::getEffectiveScheduleValue

(

)

Returns

int

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

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

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

                                                : int
    {
        $type = $this->getScheduleType();
        $value = $this->getScheduleValue();
        if (!$this->getJob()->hasFlexibleSchedule() || !$type) {
            $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

(

)

Returns

string

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

References 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 = (string) $this->getJob()->getTitle();
        if (0 === strlen($title)) {
            $title = $id;
        }

        return $title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getJob()

ilCronJobEntity::getJob

(

)

Returns

ilCronJob

Definition at line 95 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

(

)

Returns

string

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

References $jobId.

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

                               : string
    {
        return $this->jobId;
    }

Here is the caller graph for this function:

getJobResultCode()

ilCronJobEntity::getJobResultCode

(

)

Returns

string

Definition at line 183 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

(

)

Returns

int

Definition at line 239 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

(

)

Returns

string

Definition at line 191 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

(

)

Returns

int

Definition at line 167 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

(

)

Returns

int

Definition at line 207 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

(

)

Returns

int

Definition at line 199 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

(

)

Returns

int

Definition at line 175 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

(

)

Returns

int

Definition at line 135 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

(

)

Returns

int

Definition at line 159 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

(

)

Returns

int

Definition at line 151 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

(

)

Returns

int

Definition at line 143 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

(

)

Returns

string

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

References $path.

                              : string
    {
        return $this->path;
    }

getRunningTimestamp()

ilCronJobEntity::getRunningTimestamp

(

)

Returns

int

Definition at line 231 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

(

)

Returns

int

Definition at line 119 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

(

)

Returns

int

Definition at line 127 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

(

)

Returns

bool

Definition at line 255 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,null|string>

$record

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

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 caller graph for this function:

Field Documentation

$aliveTimestamp

ilCronJobEntity::$aliveTimestamp

private

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

Referenced by getAliveTimestamp().

$class

ilCronJobEntity::$class

private

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

Referenced by getClass().

$component

ilCronJobEntity::$component

private

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

Referenced by getComponent().

$isPlugin

ilCronJobEntity::$isPlugin

private

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

Referenced by __construct(), and isPlugin().

$job

ilCronJobEntity::$job

private

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

Referenced by __construct(), and getJob().

$jobId

ilCronJobEntity::$jobId

private

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

Referenced by getJobId().

$jobResultCode

ilCronJobEntity::$jobResultCode

private

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

Referenced by getJobResultCode().

$jobResultDuration

ilCronJobEntity::$jobResultDuration

private

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

Referenced by getJobResultDuration().

$jobResultMessage

ilCronJobEntity::$jobResultMessage

private

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

Referenced by getJobResultMessage().

$jobResultStatus

ilCronJobEntity::$jobResultStatus

private

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

Referenced by getJobResultStatus().

$jobResultTimestamp

ilCronJobEntity::$jobResultTimestamp

private

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

Referenced by getJobResultTimestamp().

$jobResultType

ilCronJobEntity::$jobResultType

private

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

Referenced by getJobResultType().

$jobResultUsrId

ilCronJobEntity::$jobResultUsrId

private

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

Referenced by getJobResultUsrId().

$jobStatus

ilCronJobEntity::$jobStatus

private

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

Referenced by getJobStatus().

$jobStatusTimestamp

ilCronJobEntity::$jobStatusTimestamp

private

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

Referenced by getJobStatusTimestamp().

$jobStatusType

ilCronJobEntity::$jobStatusType

private

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

Referenced by getJobStatusType().

$jobStatusUsrId

ilCronJobEntity::$jobStatusUsrId

private

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

Referenced by getJobStatusUsrId().

$path

ilCronJobEntity::$path

private

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

Referenced by getPath().

$runningTimestamp

ilCronJobEntity::$runningTimestamp

private

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

Referenced by getRunningTimestamp().

$scheduleType

ilCronJobEntity::$scheduleType

private

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

Referenced by getScheduleType().

$scheduleValue

ilCronJobEntity::$scheduleValue

private

Definition at line 21 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