Inheritance diagram for ilXapiResultsCronjob:

Collaboration diagram for ilXapiResultsCronjob:

Public Member Functions
	__construct ()

	getThisRunTS ()

	getLastRunTS ()

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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 ()

Data Fields
const	LAST_RUN_TS_SETTING_NAME = 'cron_xapi_res_eval_last_run'

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Protected Member Functions
	initThisRunTS ()

	readLastRunTS ()

	writeThisAsLastRunTS ()

	getXapiStatementsReport (ilObject $object, ilCmiXapiStatementsReportFilter $filter)

	buildReportFilter ()

	getObjectsToBeReported ()

Protected Attributes
int	$thisRunTS

int	$lastRunTS

ilLogger	$log

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
ILIAS DI Container	$dic

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilXapiResultsCronjob::__construct ( )

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

References $DIC, ilLoggerFactory\getLogger(), initThisRunTS(), and readLastRunTS().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $this->dic = $DIC;
 
         $DIC->language()->loadLanguageModule('cmix');
 
         $this->log = ilLoggerFactory::getLogger('cmix');
 
         $this->initThisRunTS();
         $this->readLastRunTS();
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildReportFilter()

ilXapiResultsCronjob::buildReportFilter ( )

protected

Definition at line 179 of file class.ilXapiResultsCronjob.php.

References getLastRunTS(), getThisRunTS(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by run().

                                           : \ilCmiXapiStatementsReportFilter
     {
         $filter = new ilCmiXapiStatementsReportFilter();
 
         $start = $end = null;
 
         if ($this->getLastRunTS() !== 0) {
             $filter->setStartDate(new ilCmiXapiDateTime($this->getLastRunTS(), IL_CAL_UNIX));
             $start = $filter->getStartDate()->get(IL_CAL_DATETIME);
         }
 
         $filter->setEndDate(new ilCmiXapiDateTime($this->getThisRunTS(), IL_CAL_UNIX));
         $end = $filter->getEndDate()->get(IL_CAL_DATETIME);
 
         $this->log->debug("use filter from ($start) until ($end)");
 
         return $filter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilXapiResultsCronjob::getDefaultScheduleType ( )

Definition at line 108 of file class.ilXapiResultsCronjob.php.

                                             : int
     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilXapiResultsCronjob::getDefaultScheduleValue ( )

Definition at line 113 of file class.ilXapiResultsCronjob.php.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilXapiResultsCronjob::getDescription ( )

Definition at line 93 of file class.ilXapiResultsCronjob.php.

                                     : string
     {
         return $this->dic->language()->txt("cron_xapi_results_evaluation_desc");
     }

◆ getId()

ilXapiResultsCronjob::getId ( )

Definition at line 83 of file class.ilXapiResultsCronjob.php.

                            : string
     {
         return 'xapi_results_evaluation';
     }

◆ getLastRunTS()

ilXapiResultsCronjob::getLastRunTS ( )

Definition at line 78 of file class.ilXapiResultsCronjob.php.

References $lastRunTS.

Referenced by buildReportFilter().

                                   : int
     {
         return $this->lastRunTS;
     }

Here is the caller graph for this function:

◆ getObjectsToBeReported()

ilXapiResultsCronjob::getObjectsToBeReported ( )

protected

Returns: mixed[]

Definition at line 201 of file class.ilXapiResultsCronjob.php.

References ilCmiXapiUser\getCmixObjectsHavingUsersMissingProxySuccess(), and ilObjCmiXapi\getObjectsHavingBypassProxyEnabledAndRegisteredUsers().

Referenced by run().

                                                : array
     {
         return array_unique(array_merge(
             ilCmiXapiUser::getCmixObjectsHavingUsersMissingProxySuccess(),
             ilObjCmiXapi::getObjectsHavingBypassProxyEnabledAndRegisteredUsers()
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThisRunTS()

ilXapiResultsCronjob::getThisRunTS ( )

Definition at line 73 of file class.ilXapiResultsCronjob.php.

References $thisRunTS.

Referenced by buildReportFilter(), and run().

                                   : int
     {
         return $this->thisRunTS;
     }

Here is the caller graph for this function:

◆ getTitle()

ilXapiResultsCronjob::getTitle ( )

Definition at line 88 of file class.ilXapiResultsCronjob.php.

                               : string
     {
         return $this->dic->language()->txt("cron_xapi_results_evaluation");
     }

◆ getXapiStatementsReport()

ilXapiResultsCronjob::getXapiStatementsReport	(	ilObject	$object,
		ilCmiXapiStatementsReportFilter	$filter
	)

protected

Definition at line 159 of file class.ilXapiResultsCronjob.php.

References ilObject\getId(), and ilCmiXapiStatementsReportFilter\setActivityId().

Referenced by run().

      : \ilCmiXapiStatementsReport {
         $filter->setActivityId($object->getActivityId());
 
         $linkBuilder = new ilCmiXapiStatementsReportLinkBuilder(
             $object->getId(),
             $object->getLrsType()->getLrsEndpointStatementsAggregationLink(),
             $filter
         );
 
         $request = new ilCmiXapiStatementsReportRequest(
             $object->getLrsType()->getBasicAuth(),
             $linkBuilder
         );
 
         return $request->queryReport($object->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ilXapiResultsCronjob::hasAutoActivation ( )

Definition at line 98 of file class.ilXapiResultsCronjob.php.

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilXapiResultsCronjob::hasFlexibleSchedule ( )

Definition at line 103 of file class.ilXapiResultsCronjob.php.

                                          : bool
     {
         return true;
     }

◆ initThisRunTS()

ilXapiResultsCronjob::initThisRunTS ( )

protected

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

Referenced by __construct().

                                       : void
     {
         $this->thisRunTS = time();
     }

Here is the caller graph for this function:

◆ readLastRunTS()

ilXapiResultsCronjob::readLastRunTS ( )

protected

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

References ILIAS\LTI\ToolProvider\$settings, and ILIAS\Repository\int().

Referenced by __construct().

                                       : void
     {
         $settings = new ilSetting('cmix');
         // Check return value of $settings->get, since this is string but a int is needed for lastRunTS
         $this->lastRunTS = (int) $settings->get(self::LAST_RUN_TS_SETTING_NAME, "0");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilXapiResultsCronjob::run ( )

Definition at line 118 of file class.ilXapiResultsCronjob.php.

References $objId, buildReportFilter(), ilObjectFactory\getInstanceByObjId(), getObjectsToBeReported(), getThisRunTS(), getXapiStatementsReport(), IL_CAL_UNIX, ilObjCmiXapi\LAUNCH_MODE_NORMAL, ilCronJobResult\STATUS_OK, ilCmiXapiUser\updateFetchedUntilForObjects(), and writeThisAsLastRunTS().

                          : ilCronJobResult
     {
         $objects = $this->getObjectsToBeReported();
         $objectIds = [];
 
         foreach ($objects as $objId) {
             $this->log->debug('handle object (' . $objId . ')');
 
             $filter = $this->buildReportFilter();
 
             $object = ilObjectFactory::getInstanceByObjId($objId, false);
 
             $evaluation = new ilXapiStatementEvaluation($this->log, $object);
 
             if ($object->getLaunchMode() != ilObjCmiXapi::LAUNCH_MODE_NORMAL) {
                 $this->log->debug('skipped object due to launch mode (' . $objId . ')');
                 continue;
             }
 
             $report = $this->getXapiStatementsReport($object, $filter);
 
             $evaluation->evaluateReport($report);
 
             //$this->log->debug('update lp for object (' . $objId . ')');
             //ilLPStatusWrapper::_refreshStatus($objId);
 
             $objectIds[] = $objId;
         }
 
         ilCmiXapiUser::updateFetchedUntilForObjects(
             new ilCmiXapiDateTime($this->getThisRunTS(), IL_CAL_UNIX),
             $objectIds
         );
 
         $result = new ilCronJobResult();
         $result->setStatus(ilCronJobResult::STATUS_OK);
 
         $this->writeThisAsLastRunTS();
         return $result;
     }

Here is the call graph for this function:

◆ writeThisAsLastRunTS()

ilXapiResultsCronjob::writeThisAsLastRunTS ( )

protected

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

References ILIAS\LTI\ToolProvider\$settings.

Referenced by run().

                                              : void
     {
         $settings = new ilSetting('cmix');
         $settings->set(self::LAST_RUN_TS_SETTING_NAME, (string) $this->thisRunTS);
     }

Here is the caller graph for this function:

Field Documentation

◆ $dic

ILIAS DI Container ilXapiResultsCronjob::$dic

private

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

◆ $lastRunTS

int ilXapiResultsCronjob::$lastRunTS

protected

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

Referenced by getLastRunTS().

◆ $log

ilLogger ilXapiResultsCronjob::$log

protected

Definition at line 38 of file class.ilXapiResultsCronjob.php.

◆ $thisRunTS

int ilXapiResultsCronjob::$thisRunTS

protected

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

Referenced by getThisRunTS().

◆ LAST_RUN_TS_SETTING_NAME

const ilXapiResultsCronjob::LAST_RUN_TS_SETTING_NAME = 'cron_xapi_res_eval_last_run'

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

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

Modules/CmiXapi/classes/class.ilXapiResultsCronjob.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildReportFilter()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getLastRunTS()

◆ getObjectsToBeReported()

◆ getThisRunTS()

◆ getTitle()

◆ getXapiStatementsReport()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ initThisRunTS()

◆ readLastRunTS()

◆ run()

◆ writeThisAsLastRunTS()

Field Documentation

◆ $dic

◆ $lastRunTS

◆ $log

◆ $thisRunTS

◆ LAST_RUN_TS_SETTING_NAME