Inheritance diagram for ILIAS\Test\Setup\MoveSettingsTemplatesMigration:

Collaboration diagram for ILIAS\Test\Setup\MoveSettingsTemplatesMigration:

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

Private Attributes
ilDBInterface	$db

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

Detailed Description

Definition at line 27 of file MoveSettingsTemplatesMigration.php.

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::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 38 of file MoveSettingsTemplatesMigration.php.

                                                   : int
    {
        return 100;
    }

◆ getLabel()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::getLabel ( )

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

Implements ILIAS\Setup\Migration.

Definition at line 33 of file MoveSettingsTemplatesMigration.php.

                              : string
    {
        return 'Migrate personal test template settings from tst_test_defaults to tst_test_settings';
    }

◆ getPreconditions()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::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 43 of file MoveSettingsTemplatesMigration.php.

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

◆ getRemainingAmountOfSteps()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::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 112 of file MoveSettingsTemplatesMigration.php.

                                               : int
    {
        $result = $this->db->query("SELECT COUNT(test_defaults_id) AS cnt FROM tst_test_defaults WHERE settings_id IS NULL");
        return (int) $this->db->fetchObject($result)->cnt;
    }

◆ prepare()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::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 48 of file MoveSettingsTemplatesMigration.php.

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

References ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Environment\RESOURCE_DATABASE.

Here is the call graph for this function:

◆ step()

ILIAS\Test\Setup\MoveSettingsTemplatesMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 53 of file MoveSettingsTemplatesMigration.php.

                                                  : void
    {
        $row = $this->db->fetchAssoc(
            $this->db->query("SELECT * FROM tst_test_defaults WHERE settings_id IS NULL LIMIT 1")
        );
 
        $settings_id = $this->db->nextId('tst_test_settings');
        $setting_data = ['id' => [\ilDBConstants::T_INTEGER, $settings_id]];
 
        // Migrate the legacy serialized column to a row in 'tst_test_settings'
        $raw_settings = unserialize($row['defaults'], ['allowed_classes' => [\DateTimeImmutable::class]]);
        foreach (self::SETTINGS_COLUMNS as $column_name => $column) {
            [$column_def, $raw_name] = $column;
            if (isset($raw_settings[$raw_name])) {
                $value = $raw_settings[$raw_name];
 
                if ($column_name === 'reporting_date') {
                    $value = $this->convertLegacyDate($value);
                }
 
                $setting_data[$column_name] = [$column_def['type'], $value];
            }
        }
 
        // Insert the new row
        $this->db->insert('tst_test_settings', $setting_data);
        $this->db->update(
            'tst_test_defaults',
            ['settings_id' => [\ilDBConstants::T_INTEGER, $settings_id]],
            ['test_defaults_id' => [\ilDBConstants::T_INTEGER, $row['test_defaults_id']]]
        );
 
        // Migrate the legacy json decoded to a row in 'tst_mark'
        $raw_marks = json_decode($row['marks'], true);
        foreach ($raw_marks as $mark_data) {
            $mark_id = $this->db->nextId('tst_mark');
            $this->db->insert(
                'tst_mark',
                [
                    'mark_id' => [\ilDBConstants::T_INTEGER, $mark_id],
                    'test_fi' => [\ilDBConstants::T_INTEGER, 0],
                    'short_name' => [\ilDBConstants::T_TEXT, $mark_data['short_name']],
                    'official_name' => [\ilDBConstants::T_TEXT, $mark_data['official_name']],
                    'minimum_level' => [\ilDBConstants::T_FLOAT, $mark_data['minimum_level']],
                    'passed' => [\ilDBConstants::T_FLOAT, (int) $mark_data['passed']],
                    'tstamp' => [\ilDBConstants::T_INTEGER, $row['tstamp']],
                ]
            );
 
            $this->db->insert(
                'tst_defaults_marks',
                [
                    'defaults_id' => [\ilDBConstants::T_INTEGER, $row['test_defaults_id']],
                    'mark_id' => [\ilDBConstants::T_INTEGER, $mark_id],
                ]
            );
        }
    }