ILIAS  release_7 Revision v7.30-3-g800a261c036
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
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)
 

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.

References $code.

Referenced by ilCronManager\updateJobResult().

69  {
70  return $this->code;
71  }
+ Here is the caller graph for this function:

◆ getCoreCodes()

static ilCronJobResult::getCoreCodes ( )
static
Returns
array

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

Referenced by ilCronManagerTableGUI\formatResultInfo().

33  {
34  return array(
35  self::CODE_NO_RESULT, self::CODE_MANUAL_RESET, self::CODE_SUPPOSED_CRASH
36  );
37  }
+ Here is the caller graph for this function:

◆ getDuration()

ilCronJobResult::getDuration ( )

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

References $duration.

Referenced by ilCronManager\updateJobResult().

79  {
80  return $this->duration;
81  }
+ Here is the caller graph for this function:

◆ getMessage()

ilCronJobResult::getMessage ( )

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

References $message.

Referenced by ilCronManager\updateJobResult().

59  {
60  return $this->message;
61  }
+ Here is the caller graph for this function:

◆ getStatus()

ilCronJobResult::getStatus ( )

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

References $status.

Referenced by ilCronManager\updateJobResult().

40  {
41  return $this->status;
42  }
+ Here is the caller graph for this function:

◆ getValidStatus()

ilCronJobResult::getValidStatus ( )
protected

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

Referenced by setStatus().

53  {
54  return array(self::STATUS_INVALID_CONFIGURATION, self::STATUS_NO_ACTION,
55  self::STATUS_OK, self::STATUS_CRASHED, self::STATUS_FAIL);
56  }
+ Here is the caller graph for this function:

◆ setCode()

ilCronJobResult::setCode (   $a_value)

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

74  {
75  $this->code = $a_value;
76  }

◆ setDuration()

ilCronJobResult::setDuration (   $a_value)

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

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

◆ setMessage()

ilCronJobResult::setMessage (   $a_value)

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

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

◆ setStatus()

ilCronJobResult::setStatus (   $a_value)

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

References getValidStatus().

45  {
46  $a_value = (int) $a_value;
47  if (in_array($a_value, $this->getValidStatus())) {
48  $this->status = $a_value;
49  }
50  }
+ 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(), ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), ilCronEcsTaskScheduler\run(), and ilCronManager\runJob().

◆ STATUS_FAIL

const ilCronJobResult::STATUS_FAIL = 6

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

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), 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 ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), and ilCronManager\runJob().

◆ STATUS_NO_ACTION

const ilCronJobResult::STATUS_NO_ACTION = 2

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

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), ilCronDeleteInactiveUserAccounts\hasCustomSettings(), ilUserCronCheckAccounts\hasFlexibleSchedule(), ilOerHarvester\run(), ilMembershipCronMinMembers\run(), ilWebResourceCronLinkCheck\run(), ilMembershipCronNotifications\run(), ilLPCronObjectStatistics\run(), ilConsultationHourCron\run(), ilLuceneIndexer\run(), ilLDAPCronSynchronization\run(), ilPrgUpdateProgressCronJob\run(), ilExcCronFeedbackNotification\run(), ilExcCronReminders\run(), ilBookingPrefBookCron\run(), ilLTICronOutcomeService\run(), ilSurveyCronNotification\run(), ilLearningModuleCronLinkCheck\run(), ilBookCronNotification\run(), ilSkillNotifications\run(), ilCronDeleteInactivatedUserAccounts\run(), ilPrgRestartAssignmentsCronJob\run(), ilPrgUserRiskyToFailCronJob\run(), ilPrgUserNotRestartedCronJob\run(), ilCertificateCron\run(), ilForumCronNotification\run(), and ilCronDeleteNeverLoggedInUserAccounts\run().

◆ STATUS_OK

const ilCronJobResult::STATUS_OK = 3

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

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

◆ STATUS_RESET

const ilCronJobResult::STATUS_RESET = 5

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

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), and ilCronManager\resetJob().

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