ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
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().

56  {
57  return $this->code;
58  }
+ 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().

66  {
67  return $this->duration;
68  }
+ 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().

46  {
47  return $this->message;
48  }
+ 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().

26  {
27  return $this->status;
28  }
+ Here is the caller graph for this function:

◆ getValidStatus()

ilCronJobResult::getValidStatus ( )
protected

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

Referenced by setStatus().

40  {
41  return array(self::STATUS_INVALID_CONFIGURATION, self::STATUS_NO_ACTION,
42  self::STATUS_OK, self::STATUS_CRASHED, self::STATUS_FAIL);
43  }
+ Here is the caller graph for this function:

◆ setCode()

ilCronJobResult::setCode (   $a_value)

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

61  {
62  $this->code = $a_value;
63  }

◆ setDuration()

ilCronJobResult::setDuration (   $a_value)

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

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

◆ setMessage()

ilCronJobResult::setMessage (   $a_value)

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

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

◆ setStatus()

ilCronJobResult::setStatus (   $a_value)

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

References getValidStatus().

31  {
32  $a_value = (int)$a_value;
33  if(in_array($a_value, $this->getValidStatus()))
34  {
35  $this->status = $a_value;
36  }
37  }
+ 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

◆ STATUS_FAIL

const ilCronJobResult::STATUS_FAIL = 6

◆ STATUS_INVALID_CONFIGURATION

const ilCronJobResult::STATUS_INVALID_CONFIGURATION = 1

◆ STATUS_NO_ACTION

◆ STATUS_OK

◆ STATUS_RESET

const ilCronJobResult::STATUS_RESET = 5

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