ilXapiResultsCronjob Class Reference

Inheritance diagram for ilXapiResultsCronjob:

Collaboration diagram for ilXapiResultsCronjob:

Public Member Functions
	__construct ()
	getThisRunTS ()
	getLastRunTS ()
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	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 ()

Data Fields
const	LAST_RUN_TS_SETTING_NAME = 'cron_xapi_res_eval_last_run'

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 ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Private Attributes
ILIAS DI Container	$dic

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilXapiResultsCronjob::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

buildReportFilter()

ilXapiResultsCronjob::buildReportFilter ( )

protected

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

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

References ilCmiXapiStatementsReportFilter\getEndDate(), ilCmiXapiStatementsReportFilter\getStartDate(), IL_CAL_DATETIME, IL_CAL_UNIX, ilCmiXapiStatementsReportFilter\setEndDate(), and ilCmiXapiStatementsReportFilter\setStartDate().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilXapiResultsCronjob::getDefaultScheduleType

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

getDefaultScheduleValue()

ilXapiResultsCronjob::getDefaultScheduleValue

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return null;
    }

getDescription()

ilXapiResultsCronjob::getDescription

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

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

getId()

ilXapiResultsCronjob::getId

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return 'xapi_results_evaluation';
    }

getLastRunTS()

ilXapiResultsCronjob::getLastRunTS

(

)

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

                                  : int
    {
        return $this->lastRunTS;
    }

References $lastRunTS.

getObjectsToBeReported()

ilXapiResultsCronjob::getObjectsToBeReported ( )

protected

Returns

mixed[]

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

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

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

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

getThisRunTS()

ilXapiResultsCronjob::getThisRunTS

(

)

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

                                  : int
    {
        return $this->thisRunTS;
    }

References $thisRunTS.

Referenced by run().

Here is the caller graph for this function:

getTitle()

ilXapiResultsCronjob::getTitle

(

)

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 92 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 163 of file class.ilXapiResultsCronjob.php.

     : \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());
    }

Referenced by run().

Here is the caller graph for this function:

hasAutoActivation()

ilXapiResultsCronjob::hasAutoActivation

(

)

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

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilXapiResultsCronjob::hasFlexibleSchedule

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

initThisRunTS()

ilXapiResultsCronjob::initThisRunTS ( )

protected

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

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

Referenced by __construct().

Here is the caller graph for this function:

readLastRunTS()

ilXapiResultsCronjob::readLastRunTS ( )

protected

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

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

References ILIAS\Repository\int().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

ilXapiResultsCronjob::run

(

)

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        $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 JobResult();
        $result->setStatus(JobResult::STATUS_OK);
 
        $this->writeThisAsLastRunTS();
        return $result;
    }

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

Here is the call graph for this function:

writeThisAsLastRunTS()

ilXapiResultsCronjob::writeThisAsLastRunTS ( )

protected

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

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

Referenced by run().

Here is the caller graph for this function:

Field Documentation

$dic

ILIAS DI Container ilXapiResultsCronjob::$dic

private

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

$lastRunTS

int ilXapiResultsCronjob::$lastRunTS

protected

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

Referenced by getLastRunTS().

$log

ilLogger ilXapiResultsCronjob::$log

protected

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

$thisRunTS

int ilXapiResultsCronjob::$thisRunTS

protected

Definition at line 38 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 36 of file class.ilXapiResultsCronjob.php.

---

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

• components/ILIAS/CmiXapi/classes/class.ilXapiResultsCronjob.php