Collaboration diagram for ilCronJobResult:

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
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
int	$status = self::STATUS_NO_ACTION

string	$message = ''

string	$code = null

string	$duration = '0'

Detailed Description

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

Member Function Documentation

◆ getCode()

ilCronJobResult::getCode ( )

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

References $code.

Referenced by ilCronJobRepositoryImpl\updateJobResult().

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

Here is the caller graph for this function:

◆ getCoreCodes()

static ilCronJobResult::getCoreCodes ( )

static

Returns: string[]

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

Referenced by ilCronManagerTableGUI\formatResultInfo().

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

Here is the caller graph for this function:

◆ getDuration()

ilCronJobResult::getDuration ( )

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

References $duration.

Referenced by ilCronJobRepositoryImpl\updateJobResult().

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

Here is the caller graph for this function:

◆ getMessage()

ilCronJobResult::getMessage ( )

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

References $message.

Referenced by ilCronJobRepositoryImpl\updateJobResult().

                                 : string
     {
         return $this->message;
     }

Here is the caller graph for this function:

◆ getStatus()

ilCronJobResult::getStatus ( )

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

References $status.

Referenced by ilCronJobRepositoryImpl\updateJobResult().

                                : int
     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ getValidStatus()

ilCronJobResult::getValidStatus ( )

protected

Returns: int[]

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

Referenced by 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()

ilCronJobResult::setCode ( string $a_value )

Definition at line 104 of file class.ilCronJobResult.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()

ilCronJobResult::setDuration ( float $a_value )

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

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

◆ setMessage()

ilCronJobResult::setMessage ( string $value )

Definition at line 89 of file class.ilCronJobResult.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()

ilCronJobResult::setStatus ( int $a_value )

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

References getValidStatus().

Referenced by ilOerHarvester\run(), and 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $code

string ilCronJobResult::$code = null

protected

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

Referenced by getCode().

◆ $duration

string ilCronJobResult::$duration = '0'

protected

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

Referenced by getDuration().

◆ $message

string ilCronJobResult::$message = ''

protected

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

Referenced by getMessage().

◆ $status

int ilCronJobResult::$status = self::STATUS_NO_ACTION

protected

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

Referenced by getStatus().

◆ CODE_MANUAL_RESET

const ilCronJobResult::CODE_MANUAL_RESET = 'job_manual_reset'

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

Referenced by ilCronManagerImpl\resetJob().

◆ CODE_NO_RESULT

const ilCronJobResult::CODE_NO_RESULT = 'job_no_result'

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

Referenced by CronJobEntityTest\getEntity().

◆ CODE_SUPPOSED_CRASH

const ilCronJobResult::CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'

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

Referenced by ilCronManagerImpl\runJob().

◆ STATUS_CRASHED

const ilCronJobResult::STATUS_CRASHED = 4

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

Referenced by ilCronManagerTableGUI\fillRow(), ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), ilCronEcsTaskScheduler\run(), ilCalendarCronRemoteReader\run(), and ilCronManagerImpl\runJob().

◆ STATUS_FAIL

const ilCronJobResult::STATUS_FAIL = 6

Definition at line 28 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 23 of file class.ilCronJobResult.php.

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), and ilCronManagerImpl\runJob().

◆ STATUS_NO_ACTION

const ilCronJobResult::STATUS_NO_ACTION = 2

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

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

◆ STATUS_OK

const ilCronJobResult::STATUS_OK = 3

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

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

◆ STATUS_RESET

const ilCronJobResult::STATUS_RESET = 5

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

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

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

Services/Cron/classes/class.ilCronJobResult.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getCode()

◆ getCoreCodes()

◆ getDuration()

◆ getMessage()

◆ getStatus()

◆ getValidStatus()

◆ setCode()

◆ setDuration()

◆ setMessage()

◆ setStatus()

Field Documentation

◆ $code

◆ $duration

◆ $message

◆ $status

◆ CODE_MANUAL_RESET

◆ CODE_NO_RESULT

◆ CODE_SUPPOSED_CRASH

◆ STATUS_CRASHED

◆ STATUS_FAIL

◆ STATUS_INVALID_CONFIGURATION

◆ STATUS_NO_ACTION

◆ STATUS_OK

◆ STATUS_RESET