Inheritance diagram for ilDataCollectionSelectionFieldMigration:

Collaboration diagram for ilDataCollectionSelectionFieldMigration:

Public Member Functions
	getLabel ()

	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...

	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...

	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

	getLabel ()

	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...

	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...

	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

Data Fields
const	DEFAULT_AMOUNT_OF_STEPS = 10000

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

Protected Attributes
ilDBInterface	$db

Detailed Description

Definition at line 23 of file class.ilDataCollectionSelectionFieldMigration.php.

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

ilDataCollectionSelectionFieldMigration::getDefaultAmountOfStepsPerRun ( )

Tell the default amount of steps to be executed for one run of the migration.

Return Migration::INFINITE if all units should be migrated at once.

Implements ILIAS\Setup\Migration.

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

                                                   : int
    {
        return self::DEFAULT_AMOUNT_OF_STEPS;
    }

References DEFAULT_AMOUNT_OF_STEPS.

◆ getLabel()

ilDataCollectionSelectionFieldMigration::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 29 of file class.ilDataCollectionSelectionFieldMigration.php.

                              : string
    {
        return "Migration of DataCollection selection field values";
    }

◆ getPreconditions()

ilDataCollectionSelectionFieldMigration::getPreconditions ( Environment $environment )

Objectives the migration depend on.

Exceptions

UnachievableException if the objective is not achievable

Returns: Objective[]

Implements ILIAS\Setup\Migration.

Definition at line 39 of file class.ilDataCollectionSelectionFieldMigration.php.

                                                              : array
    {
        return [
            new ilDatabaseInitializedObjective(),
            new ilDatabaseUpdatedObjective(),
        ];
    }

◆ getRemainingAmountOfSteps()

ilDataCollectionSelectionFieldMigration::getRemainingAmountOfSteps ( )

Count up how many "things" need to be migrated.

This helps the admin to decide how big he can create the steps and also how long a migration takes

Implements ILIAS\Setup\Migration.

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

                                               : int
    {
        $legacy_file_field_amount = $this->db->fetchObject(
            $this->db->queryF(
                'SELECT COUNT(il_dcl_stloc1_value.id) AS amount FROM il_dcl_stloc1_value ' .
                'INNER JOIN il_dcl_record_field on il_dcl_record_field.id = il_dcl_stloc1_value.record_field_id ' .
                'INNER JOIN il_dcl_field ON il_dcl_field.id = il_dcl_record_field.field_id ' .
                'WHERE (datatype_id = %s OR datatype_id = %s) AND value LIKE %s AND value NOT LIKE %s AND value != "[]"',
                [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
                [ilDclDatatype::INPUTFORMAT_TEXT_SELECTION, ilDclDatatype::INPUTFORMAT_DATE_SELECTION, '[%', '["%']
            )
        );
 
        return (int) $legacy_file_field_amount?->amount;
    }

References ilDclDatatype\INPUTFORMAT_DATE_SELECTION, ilDclDatatype\INPUTFORMAT_TEXT_SELECTION, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

◆ prepare()

ilDataCollectionSelectionFieldMigration::prepare ( Environment $environment )

Prepare the migration by means of some environment.

This is not supposed to modify the environment, but will be run to prime the migration object to run step and getRemainingAmountOfSteps afterwards.

Implements ILIAS\Setup\Migration.

Definition at line 47 of file class.ilDataCollectionSelectionFieldMigration.php.

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

◆ step()

ilDataCollectionSelectionFieldMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 52 of file class.ilDataCollectionSelectionFieldMigration.php.

                                                  : void
    {
        $stmt = $this->db->queryF(
            'SELECT il_dcl_stloc1_value.* FROM il_dcl_stloc1_value ' .
            'INNER JOIN il_dcl_record_field on il_dcl_record_field.id = il_dcl_stloc1_value.record_field_id ' .
            'INNER JOIN il_dcl_field ON il_dcl_field.id = il_dcl_record_field.field_id ' .
            'WHERE (datatype_id = %s OR datatype_id = %s) AND value LIKE %s AND value NOT LIKE %s AND value != "[]"',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            [ilDclDatatype::INPUTFORMAT_TEXT_SELECTION, ilDclDatatype::INPUTFORMAT_DATE_SELECTION, '[%', '["%']
        );
 
        while ($row = $this->db->fetchAssoc($stmt)) {
            $old_values = json_decode($row['value']);
            $new_values = [];
            foreach ($old_values as $old_value) {
                $new_values[] = (string) $old_value;
            }
            $this->db->update(
                'il_dcl_stloc1_value',
                ['value' => [ilDBConstants::T_TEXT, json_encode($new_values)]],
                ['id' => [ilDBConstants::T_INTEGER, $row['id']]]
            );
        }
    }