ilLTICronOutcomeService Class Reference

Description of class class. More...

Inheritance diagram for ilLTICronOutcomeService:

Collaboration diagram for ilLTICronOutcomeService:

Public Member Functions
	__construct ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	getId ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	getTitle ()
	getDescription ()
	run ()
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule (?CronJobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...
	getAllScheduleTypes ()
	Get all available schedule types. More...
	getScheduleTypesWithValues ()
	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...
	isManuallyExecutable ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()

Private Attributes
ilLanguage	$lng
ilCronJobRepository	$cronRepo

Additional Inherited Members
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Description of class class.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 29 of file class.ilLTICronOutcomeService.php.

Constructor & Destructor Documentation

__construct()

ilLTICronOutcomeService::__construct

(

)

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

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("lti");
        $this->cronRepo = $DIC->cron()->repository();
    }

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilLTICronOutcomeService::getDefaultScheduleType

(

)

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

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilLTICronOutcomeService::getDefaultScheduleValue

(

)

Definition at line 47 of file class.ilLTICronOutcomeService.php.

                                             : ?int
    {
        return 1;
    }

getDescription()

ilLTICronOutcomeService::getDescription

(

)

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

References ILIAS\Repository\lng().

                                    : string
    {
        return $this->lng->txt('lti_cron_title_desc');
    }

Here is the call graph for this function:

getId()

ilLTICronOutcomeService::getId

(

)

Definition at line 52 of file class.ilLTICronOutcomeService.php.

Referenced by run().

                           : string
    {
        return 'lti_outcome';
    }

Here is the caller graph for this function:

getTitle()

ilLTICronOutcomeService::getTitle

(

)

Definition at line 67 of file class.ilLTICronOutcomeService.php.

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt('lti_cron_title');
    }

Here is the call graph for this function:

hasAutoActivation()

ilLTICronOutcomeService::hasAutoActivation

(

)

Definition at line 57 of file class.ilLTICronOutcomeService.php.

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilLTICronOutcomeService::hasFlexibleSchedule

(

)

Definition at line 62 of file class.ilLTICronOutcomeService.php.

                                         : bool
    {
        return true;
    }

run()

ilLTICronOutcomeService::run

(

)

Exceptions

ilDateTimeException

Definition at line 80 of file class.ilLTICronOutcomeService.php.

References getId(), ilLTIAppEventListener\handleCronUpdate(), IL_CAL_UNIX, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                         : ilCronJobResult
    {
        $status = \ilCronJobResult::STATUS_NO_ACTION;

        $info = $this->cronRepo->getCronJobData($this->getId());
        $last_ts = $info['job_status_ts'] ?? false;
        if (!$last_ts) {
            $last_ts = time() - 24 * 3600;
        }
        $since = new ilDateTime($last_ts, IL_CAL_UNIX);


        $result = new \ilCronJobResult();
        $result->setStatus($status);
        ilLTIAppEventListener::handleCronUpdate($since);
        $result->setStatus(ilCronJobResult::STATUS_OK);

        return $result;
    }

Here is the call graph for this function:

Field Documentation

$cronRepo

ilCronJobRepository ilLTICronOutcomeService::$cronRepo

private

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

$lng

ilLanguage ilLTICronOutcomeService::$lng

private

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

---

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

• components/ILIAS/LTIProvider/classes/class.ilLTICronOutcomeService.php