ilDataCollectionStorageMigration Class Reference

AutoloadingIssuesInspection More...

Inheritance diagram for ilDataCollectionStorageMigration:

Collaboration diagram for ilDataCollectionStorageMigration:

Public Member Functions
	getLabel ()
	getDefaultAmountOfStepsPerRun ()
	getPreconditions (\ILIAS\Setup\Environment $environment)
	prepare (\ILIAS\Setup\Environment $environment)
	step (\ILIAS\Setup\Environment $environment)
	getRemainingAmountOfSteps ()
Public Member Functions inherited from ILIAS\Setup\Migration
	getPreconditions (Environment $environment)
	Objectives the migration depend on. More...
	prepare (Environment $environment)
	Prepare the migration by means of some environment. More...
	step (Environment $environment)
	Run one step of the migration. More...

Data Fields
const	DEFAULT_AMOUNT_OF_STEPS = 10000
Data Fields inherited from ILIAS\Setup\Migration
const	INFINITE = -1

Protected Attributes
ilResourceStorageMigrationHelper	$helper

Detailed Description

AutoloadingIssuesInspection

Definition at line 26 of file class.ilDataCollectionStorageMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilDataCollectionStorageMigration::getDefaultAmountOfStepsPerRun

(

)

Implements ILIAS\Setup\Migration.

Definition at line 43 of file class.ilDataCollectionStorageMigration.php.

                                                   : int
    {
        return self::DEFAULT_AMOUNT_OF_STEPS;
    }

getLabel()

ilDataCollectionStorageMigration::getLabel

(

)

Implements ILIAS\Setup\Migration.

Definition at line 35 of file class.ilDataCollectionStorageMigration.php.

                              : string
    {
        return "Migration of DataCollection files to the Resource Storage Service.";
    }

getPreconditions()

ilDataCollectionStorageMigration::getPreconditions

(

\ILIAS\Setup\Environment

$environment

)

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

References ilResourceStorageMigrationHelper\getPreconditions().

                                                                           : array
    {
        return ilResourceStorageMigrationHelper::getPreconditions();
    }

Here is the call graph for this function:

getRemainingAmountOfSteps()

ilDataCollectionStorageMigration::getRemainingAmountOfSteps

(

)

Implements ILIAS\Setup\Migration.

Definition at line 162 of file class.ilDataCollectionStorageMigration.php.

                                               : int
    {
        $legacy_file_field_amount = $this->helper->getDatabase()->fetchObject(
            $this->helper->getDatabase()->query(
                "SELECT COUNT(field.id) AS amount FROM il_dcl_field AS field WHERE field.datatype_id = 6;"
            )
        );

        return (int) $legacy_file_field_amount?->amount;
    }

prepare()

ilDataCollectionStorageMigration::prepare

(

\ILIAS\Setup\Environment

$environment

)

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

                                                                  : void
    {
        $this->helper = new ilResourceStorageMigrationHelper(
            new ilDataCollectionStakeholder(),
            $environment
        );
    }

step()

ilDataCollectionStorageMigration::step

(

\ILIAS\Setup\Environment

$environment

)

Definition at line 70 of file class.ilDataCollectionStorageMigration.php.

References ilDclDatatype\INPUTFORMAT_FILE, ILIAS\Repository\int(), and null.

                                                               : void
    {
        $integer_storage = "il_dcl_stloc2_value";
        $string_storage = "il_dcl_stloc1_value";
        $db = $this->helper->getDatabase();

        // Find next field with a fileupload datatype.

        $legacy_file_field = $db->fetchObject(
            $db->query(
                "SELECT * FROM il_dcl_field AS field WHERE datatype_id = 6 LIMIT 1;"
            )
        );

        // Loop through all records of the field.
        $legacy_file_records = $db->queryF(
            "SELECT * FROM il_dcl_record_field AS record_field WHERE record_field.field_id = %s;",
            ['integer'],
            [$legacy_file_field->id]
        );
        while ($record = $db->fetchObject($legacy_file_records)) {
            // Get the file id from the storage.
            $legacy_file_record = $db->fetchObject(
                $db->queryF(
                    "SELECT id, rid, file_id, record_field_id 
                    FROM $integer_storage AS storage 
                    JOIN file_data AS file ON file.file_id = storage.value
                    WHERE storage.record_field_id = %s;",
                    ['integer'],
                    [$record->id]
                )
            );
            if ($legacy_file_record === null) {
                continue;
            }
            // Store RID as new value in string storage.
            $rid = $legacy_file_record->rid ?? null;

            $db->insert($string_storage, [
                'id' => ['integer', $db->nextId($string_storage)],
                'record_field_id' => ['integer', (int) $legacy_file_record->record_field_id],
                'value' => ['text', $rid],
            ]);

            // Remove file_id from integer storage.
            $db->manipulateF(
                "DELETE FROM $integer_storage WHERE id = %s;",
                ['integer'],
                [(int) $legacy_file_record->id]
            );

            // Switch Stakeholder
            $this->helper->moveResourceToNewStakeholderAndOwner(
                new ResourceIdentification($rid),
                new ilObjFileStakeholder(),
                $this->helper->getStakeholder()
            );

            // Delete File-object
            try {
                $file_id = (int) $legacy_file_record->file_id;
                $db->manipulateF(
                    "DELETE FROM file_data WHERE file_id = %s",
                    ['integer'],
                    [$file_id]
                );
                $db->manipulateF(
                    "DELETE FROM history WHERE obj_id = %s",
                    ['integer'],
                    [(int) $legacy_file_record->id]
                );
                $db->manipulateF(
                    "DELETE FROM object_data WHERE obj_id = %s AND type = %s",
                    ['integer', 'text'],
                    [(int) $legacy_file_record->id, 'file']
                );
            } catch (Exception) {
                continue;
            }
        }

        // update datatype of legacy entry, so it now reads from string-storage.
        $db->update("il_dcl_field", [
            'datatype_id' => ['integer', ilDclDatatype::INPUTFORMAT_FILE],
        ], [
            'id' => ['integer', (int) $legacy_file_field->id],
        ]);
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilDataCollectionStorageMigration::$helper

protected

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

DEFAULT_AMOUNT_OF_STEPS

const ilDataCollectionStorageMigration::DEFAULT_AMOUNT_OF_STEPS = 10000

Definition at line 28 of file class.ilDataCollectionStorageMigration.php.

---

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

• components/ILIAS/DataCollection/classes/Setup/class.ilDataCollectionStorageMigration.php