Cron job result data container. More...

Collaboration diagram for ilCronJobResult:

Public Member Functions
	getStatus ()

	setStatus ($a_value)

	getMessage ()

	setMessage ($a_value)

	getCode ()

	setCode ($a_value)

	getDuration ()

	setDuration ($a_value)

Static Public Member Functions
static	getCoreCodes ()

Data Fields
const	STATUS_INVALID_CONFIGURATION = 1

const	STATUS_NO_ACTION = 2

const	STATUS_OK = 3

const	STATUS_CRASHED = 4

const	STATUS_RESET = 5

const	STATUS_FAIL = 6

const	CODE_NO_RESULT = 'job_no_result'

const	CODE_MANUAL_RESET = 'job_manual_reset'

const	CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'

Protected Member Functions
	getValidStatus ()

Protected Attributes
	$status

	$message

	$code

	$duration

Detailed Description

Cron job result data container.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilCronJobResult.php.

Member Function Documentation

◆ getCode()

ilCronJobResult::getCode ( )

Definition at line 68 of file class.ilCronJobResult.php.

    {
        return $this->code;
    }

References $code.

Referenced by ilCronManager\updateJobResult().

Here is the caller graph for this function:

◆ getCoreCodes()

static ilCronJobResult::getCoreCodes ( )

static

Returns: array

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

    {
        return array(
            self::CODE_NO_RESULT, self::CODE_MANUAL_RESET, self::CODE_SUPPOSED_CRASH
        );
    }

Referenced by ilCronManagerTableGUI\parseJobToData().

Here is the caller graph for this function:

◆ getDuration()

ilCronJobResult::getDuration ( )

Definition at line 78 of file class.ilCronJobResult.php.

    {
        return $this->duration;
    }

References $duration.

Referenced by ilCronManager\updateJobResult().

Here is the caller graph for this function:

◆ getMessage()

ilCronJobResult::getMessage ( )

Definition at line 58 of file class.ilCronJobResult.php.

    {
        return $this->message;
    }

References $message.

Referenced by ilCronManager\updateJobResult().

Here is the caller graph for this function:

◆ getStatus()

ilCronJobResult::getStatus ( )

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

    {
        return $this->status;
    }

References $status.

Referenced by ilCronManager\updateJobResult().

Here is the caller graph for this function:

◆ getValidStatus()

ilCronJobResult::getValidStatus ( )

protected

Definition at line 52 of file class.ilCronJobResult.php.

    {
        return array(self::STATUS_INVALID_CONFIGURATION, self::STATUS_NO_ACTION,
            self::STATUS_OK, self::STATUS_CRASHED, self::STATUS_FAIL);
    }

Referenced by setStatus().

Here is the caller graph for this function:

◆ setCode()

ilCronJobResult::setCode ( $a_value )

Definition at line 73 of file class.ilCronJobResult.php.

    {
        $this->code = $a_value;
    }

◆ setDuration()

ilCronJobResult::setDuration ( $a_value )

Definition at line 83 of file class.ilCronJobResult.php.

    {
        $this->duration = number_format($a_value, 3, ".", "");
    }

◆ setMessage()

ilCronJobResult::setMessage ( $a_value )

Definition at line 63 of file class.ilCronJobResult.php.

    {
        $this->message = trim($a_value);
    }

◆ setStatus()

ilCronJobResult::setStatus ( $a_value )

Definition at line 44 of file class.ilCronJobResult.php.

    {
        $a_value = (int) $a_value;
        if (in_array($a_value, $this->getValidStatus())) {
            $this->status = $a_value;
        }
    }

References getValidStatus().

Here is the call graph for this function:

Field Documentation

◆ $code

ilCronJobResult::$code

protected

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

Referenced by getCode().

◆ $duration

ilCronJobResult::$duration

protected

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

Referenced by getDuration().

◆ $message

ilCronJobResult::$message

protected

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

Referenced by getMessage().

◆ $status

ilCronJobResult::$status

protected

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

Referenced by getStatus().

◆ CODE_MANUAL_RESET

const ilCronJobResult::CODE_MANUAL_RESET = 'job_manual_reset'

Definition at line 21 of file class.ilCronJobResult.php.

Referenced by ilCronManager\resetJob().

◆ CODE_NO_RESULT

const ilCronJobResult::CODE_NO_RESULT = 'job_no_result'

Definition at line 20 of file class.ilCronJobResult.php.

Referenced by ilCronManager\runJob().

◆ CODE_SUPPOSED_CRASH

const ilCronJobResult::CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'

Definition at line 22 of file class.ilCronJobResult.php.

Referenced by ilCronManager\runJob().

◆ STATUS_CRASHED

const ilCronJobResult::STATUS_CRASHED = 4

Definition at line 16 of file class.ilCronJobResult.php.

Referenced by ilCronManagerTableGUI\fillRow(), ilCronManagerTableGUI\parseJobToData(), ilCronEcsTaskScheduler\run(), and ilCronManager\runJob().

◆ STATUS_FAIL

const ilCronJobResult::STATUS_FAIL = 6

Definition at line 18 of file class.ilCronJobResult.php.

Referenced by ilCronManagerTableGUI\parseJobToData(), ilOerHarvester\run(), and ilLuceneIndexer\run().

◆ STATUS_INVALID_CONFIGURATION

const ilCronJobResult::STATUS_INVALID_CONFIGURATION = 1

Definition at line 13 of file class.ilCronJobResult.php.

Referenced by ilCronManagerTableGUI\parseJobToData(), and ilCronManager\runJob().

◆ STATUS_NO_ACTION

const ilCronJobResult::STATUS_NO_ACTION = 2

◆ STATUS_OK

const ilCronJobResult::STATUS_OK = 3

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

Referenced by ilCronManagerTableGUI\parseJobToData(), ilBookCronNotification\run(), ilBookingPrefBookCron\run(), ilXapiResultsCronjob\run(), ilTimingsCronReminder\run(), ilExcCronFeedbackNotification\run(), ilExcCronReminders\run(), ilForumCronNotification\run(), ilLearningModuleCronLinkCheck\run(), ilCronUpdateOrgUnitPaths\run(), ilPrgInvalidateExpiredProgressesCronJob\run(), ilPrgRestartAssignmentsCronJob\run(), ilPrgUpdateProgressCronJob\run(), ilPrgUserNotRestartedCronJob\run(), ilPrgUserRiskyToFailCronJob\run(), ilSurveyCronNotification\run(), ilCronFinishUnfinishedTestPasses\run(), ilWebResourceCronLinkCheck\run(), ilConsultationHourCron\run(), ilCertificateCron\run(), ilDAVCronDiskQuota\run(), ilLDAPCronSynchronization\run(), ilLoggerCronCleanErrorFiles\run(), ilLTICronOutcomeService\run(), ilMailCronNotification\run(), ilMailCronOrphanedMails\run(), ilMembershipCronMinMembers\run(), ilMembershipCronNotifications\run(), ilOerHarvester\run(), ilCronPersonalWorkspaceRecalculateQuota\run(), ilLuceneIndexer\run(), ilSkillNotifications\run(), ilSCCronTrash\run(), ilLPCronObjectStatistics\run(), ilCronDeleteInactivatedUserAccounts\run(), ilCronDeleteNeverLoggedInUserAccounts\run(), and ilCronEcsTaskScheduler\run().

◆ STATUS_RESET

const ilCronJobResult::STATUS_RESET = 5

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

Referenced by ilCronManagerTableGUI\parseJobToData(), and ilCronManager\resetJob().

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

Services/Cron/classes/class.ilCronJobResult.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getCode()

◆ getCoreCodes()

◆ getDuration()

◆ getMessage()

◆ getStatus()

◆ getValidStatus()

◆ setCode()

◆ setDuration()

◆ setMessage()

◆ setStatus()

Field Documentation

◆ $code

◆ $duration

◆ $message

◆ $status

◆ CODE_MANUAL_RESET

◆ CODE_NO_RESULT

◆ CODE_SUPPOSED_CRASH

◆ STATUS_CRASHED

◆ STATUS_FAIL

◆ STATUS_INVALID_CONFIGURATION

◆ STATUS_NO_ACTION

◆ STATUS_OK

◆ STATUS_RESET