ilLTICronOutcomeService Class Reference

Description of class class. More...

Inheritance diagram for ilLTICronOutcomeService:

Collaboration diagram for ilLTICronOutcomeService:

Public Member Functions
	getDefaultScheduleType ()
	@inheritDoc More...
	getDefaultScheduleValue ()
	Get schedule value. Returns int|array More...
	getId ()
	Get id. Returns string More...
	hasAutoActivation ()
	Is to be activated on "installation". Returns boolean More...
	hasFlexibleSchedule ()
	Can the schedule be configured? Returns boolean More...
	getTitle ()
	getDescription ()
	run ()
	Run job. Returns ilCronJobResult More...
Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule ($a_type, $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...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...
	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...
	getId ()
	Get id. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	run ()
	Run job. More...

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
const	SCHEDULE_TYPE_IN_MINUTES = 2
const	SCHEDULE_TYPE_IN_HOURS = 3
const	SCHEDULE_TYPE_IN_DAYS = 4
const	SCHEDULE_TYPE_WEEKLY = 5
const	SCHEDULE_TYPE_MONTHLY = 6
const	SCHEDULE_TYPE_QUARTERLY = 7
const	SCHEDULE_TYPE_YEARLY = 8
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

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 11 of file class.ilLTICronOutcomeService.php.

Member Function Documentation

getDefaultScheduleType()

ilLTICronOutcomeService::getDefaultScheduleType

(

)

@inheritDoc

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilLTICronOutcomeService::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return 1;
    }

getDescription()

ilLTICronOutcomeService::getDescription

(

)

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
        $DIC->language()->loadLanguageModule('lti');
        return $DIC->language()->txt('lti_cron_title_desc');
    }

References $DIC.

getId()

ilLTICronOutcomeService::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return 'lti_outcome';
    }

Referenced by run().

Here is the caller graph for this function:

getTitle()

ilLTICronOutcomeService::getTitle

(

)

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
        $DIC->language()->loadLanguageModule('lti');
        return $DIC->language()->txt('lti_cron_title');
    }

References $DIC.

hasAutoActivation()

ilLTICronOutcomeService::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasFlexibleSchedule()

ilLTICronOutcomeService::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

run()

ilLTICronOutcomeService::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $status = \ilCronJobResult::STATUS_NO_ACTION;
 
        $info = ilCronManager::getCronJobData($this->getId());
        $last_ts = $info['job_status_ts'];
        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;
    }

References $DIC, $result, ilCronManager\getCronJobData(), getId(), ilLTIAppEventListener\handleCronUpdate(), IL_CAL_UNIX, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

---

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

• Services/LTI/classes/class.ilLTICronOutcomeService.php