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.

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

References $code.

◆ getCoreCodes()

static ilCronJobResult::getCoreCodes ( )

static

Returns: string[]

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

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

References CODE_MANUAL_RESET, CODE_NO_RESULT, and CODE_SUPPOSED_CRASH.

Referenced by ilCronManagerTableGUI\formatResultInfo().

Here is the caller graph for this function:

◆ getDuration()

ilCronJobResult::getDuration ( )

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

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

References $duration.

◆ getMessage()

ilCronJobResult::getMessage ( )

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

                                : string
    {
        return $this->message;
    }

References $message.

◆ getStatus()

ilCronJobResult::getStatus ( )

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

                               : int
    {
        return $this->status;
    }

References $status.

◆ getValidStatus()

ilCronJobResult::getValidStatus ( )

protected

Returns: int[]

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

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

References STATUS_CRASHED, STATUS_FAIL, STATUS_INVALID_CONFIGURATION, STATUS_NO_ACTION, STATUS_OK, and STATUS_RESET.

Referenced by setStatus().

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.

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

References ilStr\strLen().

Here is the call graph for this function:

◆ setStatus()

ilCronJobResult::setStatus ( int $a_value )

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

                                           : 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;
    }

References getValidStatus().

Referenced by ilOerHarvester\run(), and ilCronEcsTaskScheduler\run().

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 getCoreCodes(), and ilCronManagerImpl\resetJob().

◆ CODE_NO_RESULT

const ilCronJobResult::CODE_NO_RESULT = 'job_no_result'

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

Referenced by getCoreCodes().

◆ CODE_SUPPOSED_CRASH

const ilCronJobResult::CODE_SUPPOSED_CRASH = 'job_auto_deactivation_time_limit'

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

Referenced by getCoreCodes(), and 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(), getValidStatus(), ilCalendarCronRemoteReader\run(), ilCronEcsTaskScheduler\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(), getValidStatus(), 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(), getValidStatus(), 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(), getValidStatus(), ilBookCronNotification\run(), ilBookingPrefBookCron\run(), ilExcCronFeedbackNotification\run(), ilExcCronReminders\run(), ilForumCronNotification\run(), ilPrgRestartAssignmentsCronJob\run(), ilPrgUpdateProgressCronJob\run(), ilPrgUserNotRestartedCronJob\run(), ilPrgUserRiskyToFailCronJob\run(), ilSurveyCronNotification\run(), ilConsultationHourCron\run(), ilCalendarCronRemoteReader\run(), ilCertificateCron\run(), ilCleanCOPageHistoryCronjob\run(), ilLDAPCronSynchronization\run(), ilLTICronOutcomeService\run(), ilMembershipCronMinMembers\run(), ilMembershipCronNotifications\run(), ilOerHarvester\run(), ilLuceneIndexer\run(), ilSkillNotifications\run(), ilLPCronObjectStatistics\run(), ilCronDeleteInactivatedUserAccounts\run(), and ilCronDeleteNeverLoggedInUserAccounts\run().

◆ STATUS_OK

const ilCronJobResult::STATUS_OK = 3

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

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

◆ STATUS_RESET

const ilCronJobResult::STATUS_RESET = 5

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

Referenced by ilCronManagerTableFilterMediator\filter(), ilCronManagerTableGUI\formatResult(), getValidStatus(), 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