ilCronJobResult Class Reference

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)

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

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 55 of file class.ilCronJobResult.php.

References $code.

Referenced by ilCronManager\updateJobResult().

        {
                return $this->code;
        }

Here is the caller graph for this function:

getDuration()

ilCronJobResult::getDuration

(

)

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

References $duration.

Referenced by ilCronManager\updateJobResult().

        {
                return $this->duration;
        }

Here is the caller graph for this function:

getMessage()

ilCronJobResult::getMessage

(

)

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

References $message.

Referenced by ilCronManager\updateJobResult().

        {
                return $this->message;
        }

Here is the caller graph for this function:

getStatus()

ilCronJobResult::getStatus

(

)

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

References $status.

Referenced by ilCronManager\updateJobResult().

        {
                return $this->status;
        }

Here is the caller graph for this function:

getValidStatus()

ilCronJobResult::getValidStatus ( )

protected

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

Referenced by setStatus().

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

Here is the caller graph for this function:

setCode()

ilCronJobResult::setCode

(

$a_value

)

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

        {               
                $this->code = $a_value;         
        }       

setDuration()

ilCronJobResult::setDuration

(

$a_value

)

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

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

setMessage()

ilCronJobResult::setMessage

(

$a_value

)

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

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

setStatus()

ilCronJobResult::setStatus

(

$a_value

)

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

References getValidStatus().

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

Here is the call graph for this function:

Field Documentation

$code

ilCronJobResult::$code

protected

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

Referenced by getCode().

$duration

ilCronJobResult::$duration

protected

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

Referenced by getDuration().

$message

ilCronJobResult::$message

protected

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

Referenced by getMessage().

$status

ilCronJobResult::$status

protected

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

Referenced by getStatus().

STATUS_CRASHED

const ilCronJobResult::STATUS_CRASHED = 4

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

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

STATUS_FAIL

const ilCronJobResult::STATUS_FAIL = 6

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

Referenced by ilCronManagerTableGUI\parseJobToData(), 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

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

Referenced by ilCronDeleteInactiveUserAccounts\hasCustomSettings(), ilCronManagerTableGUI\parseJobToData(), ilMembershipCronNotifications\run(), ilMembershipCronMinMembers\run(), ilWebResourceCronLinkCheck\run(), ilLearningModuleCronLinkCheck\run(), ilSurveyCronNotification\run(), ilLuceneIndexer\run(), ilExcCronFeedbackNotification\run(), ilUserCronCheckAccounts\run(), ilLPCronObjectStatistics\run(), ilConsultationHourCron\run(), ilLDAPCronSynchronization\run(), ilCronDeleteInactivatedUserAccounts\run(), and ilForumCronNotification\run().

STATUS_OK

const ilCronJobResult::STATUS_OK = 3

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

Referenced by ilCronDeleteInactiveUserAccounts\hasCustomSettings(), ilCronManagerTableGUI\parseJobToData(), ilMembershipCronNotifications\run(), ilMembershipCronMinMembers\run(), ilWebResourceCronLinkCheck\run(), ilLearningModuleCronLinkCheck\run(), ilSurveyCronNotification\run(), ilExcCronFeedbackNotification\run(), ilLuceneIndexer\run(), ilUserCronCheckAccounts\run(), ilLPCronObjectStatistics\run(), ilMailCronNotification\run(), ilPaymentCronNotification\run(), ilConsultationHourCron\run(), ilDAVCronDiskQuota\run(), ilLDAPCronSynchronization\run(), ilCronDeleteInactivatedUserAccounts\run(), ilForumCronNotification\run(), ilMailCronOrphanedMails\run(), and ilSCCronTrash\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