ilLTICronOutcomeService Class Reference

Description of class class. More...

Inheritance diagram for ilLTICronOutcomeService:

Collaboration diagram for ilLTICronOutcomeService:

Public Member Functions
	__construct ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	getId ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getTitle ()
	getDescription ()
	run ()
Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)
	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
	usesLegacyForms ()
	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
	saveCustomConfiguration (mixed $form_data)
	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
JobRepository	$cronRepo

Additional Inherited Members
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$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 32 of file class.ilLTICronOutcomeService.php.

Constructor & Destructor Documentation

__construct()

ilLTICronOutcomeService::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilLTICronOutcomeService::getDefaultScheduleType

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

getDefaultScheduleValue()

ilLTICronOutcomeService::getDefaultScheduleValue

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return 1;
    }

getDescription()

ilLTICronOutcomeService::getDescription

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getId()

ilLTICronOutcomeService::getId

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return 'lti_outcome';
    }

Referenced by run().

Here is the caller graph for this function:

getTitle()

ilLTICronOutcomeService::getTitle

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

hasAutoActivation()

ilLTICronOutcomeService::hasAutoActivation

(

)

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilLTICronOutcomeService::hasFlexibleSchedule

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

run()

ilLTICronOutcomeService::run

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        $status = \ILIAS\Cron\Job\JobResult::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 \ILIAS\Cron\Job\JobResult();
        $result->setStatus($status);
        ilLTIAppEventListener::handleCronUpdate($since);
        $result->setStatus(JobResult::STATUS_OK);
 
        return $result;
    }

References $info, getId(), ilLTIAppEventListener\handleCronUpdate(), IL_CAL_UNIX, and ILIAS\Cron\Job\JobResult\STATUS_NO_ACTION.

Here is the call graph for this function:

Field Documentation

$cronRepo

JobRepository ilLTICronOutcomeService::$cronRepo

private

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

$lng

ilLanguage ilLTICronOutcomeService::$lng

private

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

---

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

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