Inheritance diagram for ilCmiXapiDelCron:

Collaboration diagram for ilCmiXapiDelCron:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	@inheritdoc More...

	hasFlexibleSchedule ()
	@inheritdoc More...

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

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

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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	JOB_ID = 'xapi_deletion_cron'

Protected Member Functions
	hasLrsType ()

	getLrsType ()

Protected Attributes
ilCmiXapiLrsType	$lrsType

ilCmiXapiDelModel	$model

ilLogger	$log

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
ILIAS DI Container	$dic

Detailed Description

Class ilCmiXapiDelCron.

Author: Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de; Stefan Schneider

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

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiDelCron::__construct ( )

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

References $DIC, ILIAS\LTI\ToolProvider\$settings, ilLoggerFactory\getLogger(), and ilCmiXapiDelModel\init().

     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $this->dic = $DIC;
 
         $DIC->language()->loadLanguageModule('cmix');
 
         $this->log = ilLoggerFactory::getLogger('cmix');
 
         $settings = new ilSetting(self::JOB_ID);
         $lrsTypeId = $settings->get('lrs_type_id', '0');
 
         if($lrsTypeId) {
             $this->lrsType = new ilCmiXapiLrsType((int) $lrsTypeId);
         } else {
             $this->lrsType = null;
         }
 
         $this->model = ilCmiXapiDelModel::init();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCmiXapiDelCron::getDefaultScheduleType ( )

Definition at line 94 of file class.ilCmiXapiDelCron.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCmiXapiDelCron::getDefaultScheduleValue ( )

Definition at line 99 of file class.ilCmiXapiDelCron.php.

◆ getDescription()

ilCmiXapiDelCron::getDescription ( )

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

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

◆ getId()

ilCmiXapiDelCron::getId ( )

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

                            : string
     {
         return self::JOB_ID;
     }

◆ getLrsType()

ilCmiXapiDelCron::getLrsType ( )

protected

Definition at line 109 of file class.ilCmiXapiDelCron.php.

References $lrsType.

Referenced by hasLrsType().

     {
         return $this->lrsType;
     }

Here is the caller graph for this function:

◆ getTitle()

ilCmiXapiDelCron::getTitle ( )

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

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

◆ hasAutoActivation()

ilCmiXapiDelCron::hasAutoActivation ( )

@inheritdoc

Definition at line 81 of file class.ilCmiXapiDelCron.php.

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilCmiXapiDelCron::hasFlexibleSchedule ( )

@inheritdoc

Definition at line 89 of file class.ilCmiXapiDelCron.php.

                                          : bool
     {
         return true;
     }

◆ hasLrsType()

ilCmiXapiDelCron::hasLrsType ( )

protected

Definition at line 104 of file class.ilCmiXapiDelCron.php.

References getLrsType().

     {
         return $this->getLrsType() !== null;
     }

Here is the call graph for this function:

◆ run()

ilCmiXapiDelCron::run ( )

Definition at line 114 of file class.ilCmiXapiDelCron.php.

References $DIC, $objId, ilCmiXapiStatementsDeleteRequest\DELETE_SCOPE_ALL, ilCmiXapiStatementsDeleteRequest\DELETE_SCOPE_OWN, ilCronJobResult\STATUS_FAIL, and ilCronJobResult\STATUS_OK.

                          : ilCronJobResult
     {
         global $DIC;
         $cronResult = new ilCronJobResult();
         $this->log->debug('run');
 
         // LRS - Ist Client gelöscht?
         // LRS - Wenn Client gelöscht dann nix machen
         // LRS - Wenn Client gelöscht wirklich alle Daten weg?
         // Wenn Objekt gelöscht warum wird es nochmal bei Nutzer aufgeführt (Tabelle gucken)
         // xxx Löschen wenn nut Lernerfahrung anzeigen dann nur anzeigen nicht löschen = kein Datenadmin
 
         /*
         Fall 1:
             * Objekt deleted (in Tabelle xapidel_object eingetragen mit Feld updated=null)
         => xapidel_object aktualisieren mit updated
         => hole alle Daten zu Users aus xxcf_users und die Daten zum lrs und activity_id aus xapidel_object inkl. xxcf_data_types
         => Löschvorgang an LRS-typ schicken
         => wenn's geklappt hat: Zeile aus xxcf_users löschen
         => wenn's für alle user geklappt hat: Zeile aus xxcf_data_settings löschen
         => wenn ggf. auch user gelöscht wurde und der user nur dieses objekt bearbeitet hat, dann lösche auch Zeile in xpidel_user
 
 
         Fall 2:
             * User deleted (in Tabelle xapidel_user eingetragen mit Feld updated=null)
             * Objekt noch vorhanden (kein Eintrag in Tabelle xapidel_object)
         => xapidel_user aktualisieren mit updated
         => hole alle Daten zum User aus xxcf_users und die Daten zum lrs und activity_id aus xxcf_settings inkl. xxcf_data_types
         => Löschvorgang an LRS-typ schicken
         => wenn's geklappt hat: Zeile aus xxcf_users löschen
         => wenn's für alle Objekte, die der User genutzt hat, gelöscht wurde: Zeile in xapidel_user löschen
 
         Fall 3:
             * User deleted (in Tabelle xapidel_user eingetragen mit Feld updated=null)
             * Objekt auch deleted (Eintrag in Tabelle xapidel_object mit updated=null)
             => xapidel_user aktualisieren mit updated
             => xapidel_object aktualisieren mit updated
             => hole alle Daten zum User aus xxcf_users und die Daten zum lrs und activity_id aus xapidel_object inkl. xxcf_data_types
             => Löschvorgang an LRS-typ schicken
             => wenn's geklappt hat: Zeile aus xxcf_users löschen
             => wenn's für alle Objekte, die der User genutzt hat, gelöscht wurde: Zeile in xapidel_user löschen
             => Zeile in Tabelle xapidel_object löschen
 
         */
 
         // Fall 1:
         // check deleted objects where updated = NULL
 
         $newDeletedObjects = $this->model->getNewDeletedXapiObjects();
         //ilLoggerFactory::getRootLogger()->alert(var_export($newDeletedObjects,TRUE));
 
         $deletedObjectData = array();
         $allDone = true;
         foreach ($newDeletedObjects as $deletedObject) {
             $this->log->debug("delete for " . (string)$deletedObject['obj_id']);
             // set object to updated
             $this->model->setXapiObjAsUpdated($deletedObject['obj_id']);
             // delete data
             $deleteRequest = new ilCmiXapiStatementsDeleteRequest(
                 (int) $deletedObject['obj_id'],
                 (int) $deletedObject['type_id'],
                 (string) $deletedObject['activity_id'],
                 null,
                 ilCmiXapiStatementsDeleteRequest::DELETE_SCOPE_ALL
             );
             $done = $deleteRequest->delete();
             // entry in xxcf_users is already deleted from ilXapiCmi5StatementsDeleteRequest
             // delete in obj_id from xxcf_data_settings
             if ($done) {
                 $this->log->debug("deleted data for object: " . (string)$deletedObject['obj_id']);
                 $deletedObjectData[] = $deletedObject['obj_id'];
                 $this->model->deleteXapiObjectEntry($deletedObject['obj_id']);
             } else {
                 $this->log->debug("error: delete data for object: " . (string) $deletedObject['obj_id']);
                 $this->model->resetUpdatedXapiObj($deletedObject['obj_id']);
                 $allDone = false;
             }
         }
 
         // Fall 2:
         // check deleted users where updated = NULL
         $newDeletedUsers = $this->model->getNewDeletedUsers();
         foreach ($newDeletedUsers as $deletedUser) {
             $usrId = $deletedUser['usr_id'];
             $objId = $deletedUser['obj_id'];
             // set user to updated
             $this->model->setUserAsUpdated($usrId);
             $xapiObject = $this->model->getXapiObjectData($objId);
             // check if all object data already successfully deleted in previous step within this run, because object was also deleted
             if (in_array($objId, $deletedObjectData)) {
                 $this->log->debug("nothing to do, because of complete object data deletion in previous step");
                 continue;
             }
             $deleteRequest = new ilCmiXapiStatementsDeleteRequest(
                 (int) $objId,
                 (int) $xapiObject['lrs_type_id'],
                 (string) $xapiObject['activity_id'],
                 $usrId,
                 ilCmiXapiStatementsDeleteRequest::DELETE_SCOPE_OWN
             );
             $done = $deleteRequest->delete();
             // entry in xxcf_users is already deleted from ilXapiCmi5StatementsDeleteRequest
             if ($done) {
                 $this->model->deleteUserEntry($usrId, $objId);
                 $this->log->debug("deleted object " . (string) $objId . " data for user " . (string) $usrId);
             } else {
                 $this->log->debug("error deleting object " . (string) $objId . " data for user " . (string) $usrId);
                 $this->model->resetUpdatedXapiUser($usrId, $objId);
                 $allDone = false;
             }
         }
 
         // Fall 3 wird noch gebraucht? NEIN
 
         if ($allDone) {
             $cronResult->setStatus(ilCronJobResult::STATUS_OK);
         } else {
             $cronResult->setStatus(ilCronJobResult::STATUS_FAIL);
         }
         return $cronResult;
     }

Field Documentation

◆ $dic

ILIAS DI Container ilCmiXapiDelCron::$dic

private

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

◆ $log

ilLogger ilCmiXapiDelCron::$log

protected

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

◆ $lrsType

ilCmiXapiLrsType ilCmiXapiDelCron::$lrsType

protected

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

Referenced by getLrsType().

◆ $model

ilCmiXapiDelModel ilCmiXapiDelCron::$model

protected

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

◆ JOB_ID

const ilCmiXapiDelCron::JOB_ID = 'xapi_deletion_cron'

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

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

Modules/CmiXapi/classes/class.ilCmiXapiDelCron.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getLrsType()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ hasLrsType()

◆ run()

Field Documentation

◆ $dic

◆ $log

◆ $lrsType

◆ $model

◆ JOB_ID