Inheritance diagram for ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration:

Collaboration diagram for ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration:

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 Member Functions
	dropColumn (string $table, string $column)

Private Attributes
const array	UNUSED_LEGACY_COLUMNS

ilDBInterface	$db

bool	$data_loss_detected = false

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

Detailed Description

Definition at line 27 of file RemoveLegacyTestSettingsMigration.php.

Member Function Documentation

◆ dropColumn()

ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration::dropColumn	(	string	$table,
		string	$column
	)

private

Definition at line 111 of file RemoveLegacyTestSettingsMigration.php.

                                                              : void
    {
        if ($this->db->tableColumnExists($table, $column)) {
            $this->db->dropTableColumn($table, $column);
        }
    }

Referenced by ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration\step().

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

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

◆ getLabel()

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

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

Implements ILIAS\Setup\Migration.

Definition at line 51 of file RemoveLegacyTestSettingsMigration.php.

                              : string
    {
        return 'Remove columns from tst_tests and tst_test_defaults that are now in tst_test_settings';
    }

◆ getPreconditions()

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

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

◆ getRemainingAmountOfSteps()

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

                                               : int
    {
        return (int) ($this->db->tableColumnExists('tst_tests', array_key_first(self::SETTINGS_COLUMNS))
            || $this->db->tableColumnExists('tst_tests', self::UNUSED_LEGACY_COLUMNS[0])
            || $this->db->tableColumnExists('tst_test_defaults', 'defaults'));
    }

◆ prepare()

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

                                                     : void
    {
        $this->db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
 
        $move_settings = new MoveTestSettingsMigration();
        $move_settings->prepare($environment);
        if ($move_settings->getRemainingAmountOfSteps() > 0) {
            $this->data_loss_detected = true;
            return;
        }
 
        $move_templates = new MoveSettingsTemplatesMigration();
        $move_templates->prepare($environment);
        if ($move_templates->getRemainingAmountOfSteps() > 0) {
            $this->data_loss_detected = true;
            return;
        }
    }

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

Here is the call graph for this function:

◆ step()

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

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 87 of file RemoveLegacyTestSettingsMigration.php.

                                                  : void
    {
        if ($this->data_loss_detected) {
            throw new Setup\UnachievableException(
                'Failed to remove legacy test settings. Please run MoveTestSettingsMigration and MoveSettingsTemplatesMigration first.'
            );
        }
 
        $test_columns = array_merge(array_keys(self::SETTINGS_COLUMNS), self::UNUSED_LEGACY_COLUMNS);
        foreach ($test_columns as $column) {
            $this->dropColumn('tst_tests', $column);
        }
 
        $this->dropColumn('tst_test_defaults', 'marks');
        $this->dropColumn('tst_test_defaults', 'defaults');
    }

References ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration\dropColumn().

Here is the call graph for this function:

Field Documentation

◆ $data_loss_detected

bool ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration::$data_loss_detected = false

private

Definition at line 49 of file RemoveLegacyTestSettingsMigration.php.

◆ $db

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

private

Definition at line 48 of file RemoveLegacyTestSettingsMigration.php.

◆ UNUSED_LEGACY_COLUMNS

const array ILIAS\Test\Setup\RemoveLegacyTestSettingsMigration::UNUSED_LEGACY_COLUMNS

private

Initial value:

= [
        'ects_output',
        'ects_fx',
        'ects_a',
        'ects_b',
        'ects_c',
        'ects_d',
        'ects_e',
        'keep_questions',
        'mc_scoring',
        'show_question_titles',
        'certificate_visibility',
        'resultoutput',
        'pool_usage',
        'info_screen',
    ]

Definition at line 31 of file RemoveLegacyTestSettingsMigration.php.

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

components/ILIAS/Test/src/Setup/RemoveLegacyTestSettingsMigration.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dropColumn()

◆ getDefaultAmountOfStepsPerRun()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ prepare()

◆ step()

Field Documentation

◆ $data_loss_detected

◆ $db

◆ UNUSED_LEGACY_COLUMNS