ilXapiResultsCronjob Class Reference

Inheritance diagram for ilXapiResultsCronjob:

Collaboration diagram for ilXapiResultsCronjob:

Public Member Functions
	__construct ()
	getThisRunTS ()
	getLastRunTS ()
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasCustomSettings ()
	run ()
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...

Data Fields
const	LAST_RUN_TS_SETTING_NAME = 'cron_xapi_res_eval_last_run'
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
	initThisRunTS ()
	readLastRunTS ()
	writeThisAsLastRunTS ()
	getXapiStatementsReport (ilObjCmiXapi $object, ilCmiXapiStatementsReportFilter $filter)
	buildReportFilter ()
	getObjectsToBeReported ()
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$thisRunTS
	$lastRunTS
	$log

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilXapiResultsCronjob::__construct

(

)

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

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $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 173 of file class.ilXapiResultsCronjob.php.

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

Referenced by run().

    {
        $filter = new ilCmiXapiStatementsReportFilter();
        
        $start = $end = null;
        
        if ($this->getLastRunTS()) {
            $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 100 of file class.ilXapiResultsCronjob.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilXapiResultsCronjob::getDefaultScheduleValue

(

)

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

    {
        return;
    }

getDescription()

ilXapiResultsCronjob::getDescription

(

)

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

References $DIC.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        return $DIC->language()->txt("cron_xapi_results_evaluation_desc");
    }

getId()

ilXapiResultsCronjob::getId

(

)

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

    {
        return 'xapi_results_evaluation';
    }

getLastRunTS()

ilXapiResultsCronjob::getLastRunTS

(

)

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

References $lastRunTS.

Referenced by buildReportFilter().

    {
        return $this->lastRunTS;
    }

Here is the caller graph for this function:

getObjectsToBeReported()

ilXapiResultsCronjob::getObjectsToBeReported ( )

protected

Returns

array

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

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

Referenced by run().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getThisRunTS()

ilXapiResultsCronjob::getThisRunTS

(

)

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

References $thisRunTS.

Referenced by buildReportFilter(), and run().

    {
        return $this->thisRunTS;
    }

Here is the caller graph for this function:

getTitle()

ilXapiResultsCronjob::getTitle

(

)

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

References $DIC.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        return $DIC->language()->txt("cron_xapi_results_evaluation");
    }

getXapiStatementsReport()

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

protected

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

References ilObjCmiXapi\getActivityId(), ilObjCmiXapi\getLrsType(), and ilCmiXapiStatementsReportFilter\setActivityId().

Referenced by run().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasAutoActivation()

ilXapiResultsCronjob::hasAutoActivation

(

)

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

    {
        return false;
    }

hasCustomSettings()

ilXapiResultsCronjob::hasCustomSettings

(

)

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

    {
        return false;
    }

hasFlexibleSchedule()

ilXapiResultsCronjob::hasFlexibleSchedule

(

)

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

    {
        return true;
    }

initThisRunTS()

ilXapiResultsCronjob::initThisRunTS ( )

protected

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

Referenced by __construct().

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

Here is the caller graph for this function:

readLastRunTS()

ilXapiResultsCronjob::readLastRunTS ( )

protected

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

Referenced by __construct().

    {
        $settings = new ilSetting('cmix');
        $this->lastRunTS = $settings->get(self::LAST_RUN_TS_SETTING_NAME, 0);
    }

Here is the caller graph for this function:

run()

ilXapiResultsCronjob::run

(

)

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

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

    {
        $objects = $this->getObjectsToBeReported();
        
        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 57 of file class.ilXapiResultsCronjob.php.

Referenced by run().

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

Here is the caller graph for this function:

Field Documentation

$lastRunTS

ilXapiResultsCronjob::$lastRunTS

protected

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

Referenced by getLastRunTS().

$log

ilXapiResultsCronjob::$log

protected

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

$thisRunTS

ilXapiResultsCronjob::$thisRunTS

protected

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

---

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

• Modules/CmiXapi/classes/class.ilXapiResultsCronjob.php