Collaboration diagram for ILIAS\BackgroundTasks\Task\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\BackgroundTasks\Task\Job\JobResult::getCode ( )

Definition at line 103 of file JobResult.php.

References ILIAS\BackgroundTasks\Task\Job\JobResult\$code.

                              : ?string
     {
         return $this->code;
     }

◆ getCoreCodes()

static ILIAS\BackgroundTasks\Task\Job\JobResult::getCoreCodes ( )

static

Returns: list<string>

Definition at line 44 of file JobResult.php.

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

                                          : array
     {
         return [
             self::CODE_NO_RESULT,
             self::CODE_MANUAL_RESET,
             self::CODE_SUPPOSED_CRASH,
         ];
     }

Here is the caller graph for this function:

◆ getDuration()

ILIAS\BackgroundTasks\Task\Job\JobResult::getDuration ( )

Definition at line 123 of file JobResult.php.

References ILIAS\BackgroundTasks\Task\Job\JobResult\$duration.

                                  : float
     {
         return (float) $this->duration;
     }

◆ getMessage()

ILIAS\BackgroundTasks\Task\Job\JobResult::getMessage ( )

Definition at line 88 of file JobResult.php.

References ILIAS\BackgroundTasks\Task\Job\JobResult\$message.

                                 : string
     {
         return $this->message;
     }

◆ getStatus()

ILIAS\BackgroundTasks\Task\Job\JobResult::getStatus ( )

Definition at line 53 of file JobResult.php.

References ILIAS\BackgroundTasks\Task\Job\JobResult\$status.

                                : int
     {
         return $this->status;
     }

◆ getValidStatus()

ILIAS\BackgroundTasks\Task\Job\JobResult::getValidStatus ( )

protected

Returns: list<int>

Definition at line 76 of file JobResult.php.

Referenced by ILIAS\BackgroundTasks\Task\Job\JobResult\setStatus().

                                        : array
     {
         return [
             self::STATUS_INVALID_CONFIGURATION,
             self::STATUS_NO_ACTION,
             self::STATUS_OK,
             self::STATUS_CRASHED,
             self::STATUS_FAIL,
             self::STATUS_RESET,
         ];
     }

Here is the caller graph for this function:

◆ setCode()

ILIAS\BackgroundTasks\Task\Job\JobResult::setCode ( string $a_value )

Definition at line 108 of file JobResult.php.

                                             : void
     {
         if (!\in_array($a_value, self::getCoreCodes(), true)) {
             throw new \InvalidArgumentException(
                 \sprintf(
                     'The passed code "%s" is not valid, must be of one of: %s',
                     $a_value,
                     implode(', ', self::getCoreCodes())
                 )
             );
         }
 
         $this->code = $a_value;
     }

◆ setDuration()

ILIAS\BackgroundTasks\Task\Job\JobResult::setDuration ( float $a_value )

Definition at line 128 of file JobResult.php.

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

◆ setMessage()

ILIAS\BackgroundTasks\Task\Job\JobResult::setMessage ( string $value )

Definition at line 93 of file JobResult.php.

References ilStr\strLen().

                                              : void
     {
         $value = trim($value);
         if (\ilStr::strLen($value) > 400) {
             throw new \InvalidArgumentException('The message must not exceed 400 characters');
         }
 
         $this->message = $value;
     }

Here is the call graph for this function:

◆ setStatus()

ILIAS\BackgroundTasks\Task\Job\JobResult::setStatus ( int $a_value )

Definition at line 58 of file JobResult.php.

References ILIAS\BackgroundTasks\Task\Job\JobResult\getValidStatus().

Referenced by ilCronEcsTaskScheduler\run().

                                            : void
     {
         if (!\in_array($a_value, $this->getValidStatus(), true)) {
             throw new \InvalidArgumentException(
                 \sprintf(
                     'The passed status "%s" is not valid, must be of one of: %s',
                     $a_value,
                     implode(', ', $this->getValidStatus())
                 )
             );
         }
 
         $this->status = $a_value;
     }