ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\Cron\Job\JobResult Class Reference
+ Collaboration diagram for ILIAS\Cron\Job\JobResult:

Public Member Functions

 getStatus ()
 
 setStatus (int $a_value)
 
 getMessage ()
 
 setMessage (string $value)
 
 getCode ()
 
 setCode (string $a_value)
 
 getDuration ()
 
 setDuration (float $a_value)
 

Static Public Member Functions

static getCoreCodes ()
 

Data Fields

final const int STATUS_INVALID_CONFIGURATION = 1
 
final const int STATUS_NO_ACTION = 2
 
final const int STATUS_OK = 3
 
final const int STATUS_CRASHED = 4
 
final const int STATUS_RESET = 5
 
final const int STATUS_FAIL = 6
 
final const string CODE_NO_RESULT = 'job_no_result'
 
final const string CODE_MANUAL_RESET = 'job_manual_reset'
 
final const string CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'
 

Protected Member Functions

 getValidStatus ()
 

Protected Attributes

int $status = self::STATUS_NO_ACTION
 
string $message = ''
 
string $code = null
 
string $duration = '0'
 

Detailed Description

Definition at line 23 of file JobResult.php.

Member Function Documentation

◆ getCode()

ILIAS\Cron\Job\JobResult::getCode ( )

Definition at line 103 of file JobResult.php.

103 : ?string
104 {
105 return $this->code;
106 }

References ILIAS\Cron\Job\JobResult\$code.

◆ getCoreCodes()

static ILIAS\Cron\Job\JobResult::getCoreCodes ( )
static
Returns
list<string>

Definition at line 44 of file JobResult.php.

44 : array
45 {
46 return [
50 ];
51 }
final const string CODE_SUPPOSED_CRASH
Definition: JobResult.php:34
final const string CODE_NO_RESULT
Definition: JobResult.php:32
final const string CODE_MANUAL_RESET
Definition: JobResult.php:33

References ILIAS\Cron\Job\JobResult\CODE_MANUAL_RESET, ILIAS\Cron\Job\JobResult\CODE_NO_RESULT, and ILIAS\Cron\Job\JobResult\CODE_SUPPOSED_CRASH.

Referenced by ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo().

+ Here is the caller graph for this function:

◆ getDuration()

ILIAS\Cron\Job\JobResult::getDuration ( )

Definition at line 123 of file JobResult.php.

123 : float
124 {
125 return (float) $this->duration;
126 }

References ILIAS\Cron\Job\JobResult\$duration.

◆ getMessage()

ILIAS\Cron\Job\JobResult::getMessage ( )

Definition at line 88 of file JobResult.php.

88 : string
89 {
90 return $this->message;
91 }

References ILIAS\Cron\Job\JobResult\$message.

◆ getStatus()

ILIAS\Cron\Job\JobResult::getStatus ( )

Definition at line 53 of file JobResult.php.

53 : int
54 {
55 return $this->status;
56 }

References ILIAS\Cron\Job\JobResult\$status.

◆ getValidStatus()

ILIAS\Cron\Job\JobResult::getValidStatus ( )
protected

◆ setCode()

ILIAS\Cron\Job\JobResult::setCode ( string  $a_value)

Definition at line 108 of file JobResult.php.

108 : void
109 {
110 if (!\in_array($a_value, self::getCoreCodes(), true)) {
111 throw new \InvalidArgumentException(
112 \sprintf(
113 'The passed code "%s" is not valid, must be of one of: %s',
114 $a_value,
115 implode(', ', self::getCoreCodes())
116 )
117 );
118 }
119
120 $this->code = $a_value;
121 }

◆ setDuration()

ILIAS\Cron\Job\JobResult::setDuration ( float  $a_value)

Definition at line 128 of file JobResult.php.

128 : void
129 {
130 $this->duration = number_format($a_value, 3, '.', '');
131 }

◆ setMessage()

ILIAS\Cron\Job\JobResult::setMessage ( string  $value)

Definition at line 93 of file JobResult.php.

93 : void
94 {
95 $value = trim($value);
96 if (\ilStr::strLen($value) > 400) {
97 throw new \InvalidArgumentException('The message must not exceed 400 characters');
98 }
99
100 $this->message = $value;
101 }
static strLen(string $a_string)
Definition: class.ilStr.php:60

References ilStr\strLen().

+ Here is the call graph for this function:

◆ setStatus()

ILIAS\Cron\Job\JobResult::setStatus ( int  $a_value)

Definition at line 58 of file JobResult.php.

58 : void
59 {
60 if (!\in_array($a_value, $this->getValidStatus(), true)) {
61 throw new \InvalidArgumentException(
62 \sprintf(
63 'The passed status "%s" is not valid, must be of one of: %s',
64 $a_value,
65 implode(', ', $this->getValidStatus())
66 )
67 );
68 }
69
70 $this->status = $a_value;
71 }

References ILIAS\Cron\Job\JobResult\getValidStatus().

Referenced by ilCronEcsTaskScheduler\run().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $code

string ILIAS\Cron\Job\JobResult::$code = null
protected

Definition at line 38 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getCode().

◆ $duration

string ILIAS\Cron\Job\JobResult::$duration = '0'
protected

Definition at line 39 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getDuration().

◆ $message

string ILIAS\Cron\Job\JobResult::$message = ''
protected

Definition at line 37 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getMessage().

◆ $status

int ILIAS\Cron\Job\JobResult::$status = self::STATUS_NO_ACTION
protected

Definition at line 36 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getStatus().

◆ CODE_MANUAL_RESET

final const string ILIAS\Cron\Job\JobResult::CODE_MANUAL_RESET = 'job_manual_reset'

◆ CODE_NO_RESULT

final const string ILIAS\Cron\Job\JobResult::CODE_NO_RESULT = 'job_no_result'

Definition at line 32 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getCoreCodes().

◆ CODE_SUPPOSED_CRASH

final const string ILIAS\Cron\Job\JobResult::CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'

Definition at line 34 of file JobResult.php.

Referenced by ILIAS\Cron\Job\JobResult\getCoreCodes().

◆ STATUS_CRASHED

final const int ILIAS\Cron\Job\JobResult::STATUS_CRASHED = 4

◆ STATUS_FAIL

final const int ILIAS\Cron\Job\JobResult::STATUS_FAIL = 6

◆ STATUS_INVALID_CONFIGURATION

final const int ILIAS\Cron\Job\JobResult::STATUS_INVALID_CONFIGURATION = 1

◆ STATUS_NO_ACTION

final const int ILIAS\Cron\Job\JobResult::STATUS_NO_ACTION = 2

◆ STATUS_OK

final const int ILIAS\Cron\Job\JobResult::STATUS_OK = 3

◆ STATUS_RESET

final const int ILIAS\Cron\Job\JobResult::STATUS_RESET = 5

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