ILIAS\Test\Setup\MoveTestSettingsMigration Class Reference

Inheritance diagram for ILIAS\Test\Setup\MoveTestSettingsMigration:

Collaboration diagram for ILIAS\Test\Setup\MoveTestSettingsMigration:

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
IOWrapper	$io

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

Detailed Description

Definition at line 28 of file MoveTestSettingsMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

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

                                                   : int
    {
        return 100;
    }

getLabel()

ILIAS\Test\Setup\MoveTestSettingsMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 35 of file MoveTestSettingsMigration.php.

                              : string
    {
        return 'Migrate test settings from tst_tests to tst_test_settings';
    }

getPreconditions()

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

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

getRemainingAmountOfSteps()

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

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

prepare()

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

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

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

Here is the call graph for this function:

step()

ILIAS\Test\Setup\MoveTestSettingsMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 56 of file MoveTestSettingsMigration.php.

                                                  : void
    {
        $columns = implode(',', array_keys(self::SETTINGS_COLUMNS));
        $row = $this->db->fetchAssoc(
            $this->db->query("SELECT test_id, {$columns} FROM tst_tests WHERE settings_id IS NULL LIMIT 1")
        );
 
        $settings_id = $this->db->nextId('tst_test_settings');
        $setting_data = ['id' => [\ilDBConstants::T_INTEGER, $settings_id]];
 
        foreach ($row as $column_name => $value) {
            if (isset(self::SETTINGS_COLUMNS[$column_name])) {
                [$column_def] = self::SETTINGS_COLUMNS[$column_name];
 
                if ($column_name === 'reporting_date') {
                    $value = $this->convertLegacyDate($value);
                }
                if ($column_name === 'nr_of_tries' && $value > 127) {
                    $this->io->inform(
                        "ID {$settings_id}: Tried to set nr_of_tries to {$value}, which is too high. Setting it to 127 instead."
                    );
                    $value = 127;
                }
 
                // Convert legacy null values to 0
                if ($column_def['type'] === \ilDBConstants::T_INTEGER && !$this->columnIsNullable($column_def)) {
                    $value = (int) $value;
                }
 
                $setting_data[$column_name] = [$column_def['type'], $value];
            }
        }
 
        $this->db->insert('tst_test_settings', $setting_data);
        $this->db->update(
            'tst_tests',
            ['settings_id' => [\ilDBConstants::T_INTEGER, $settings_id]],
            ['test_id' => [\ilDBConstants::T_INTEGER, $row['test_id']]]
        );
    }

References ILIAS\Test\Setup\columnIsNullable(), ILIAS\Test\Setup\convertLegacyDate(), ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ILIAS\Test\Setup\MoveTestSettingsMigration::$db

private

Definition at line 32 of file MoveTestSettingsMigration.php.

$io

IOWrapper ILIAS\Test\Setup\MoveTestSettingsMigration::$io

private

Definition at line 33 of file MoveTestSettingsMigration.php.

---

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

• components/ILIAS/Test/src/Setup/MoveTestSettingsMigration.php