ILIAS\Setup\SelectOptionsMigration Class Reference

Inheritance diagram for ILIAS\Setup\SelectOptionsMigration:

Collaboration diagram for ILIAS\Setup\SelectOptionsMigration:

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

Protected Attributes
ilDBInterface	$db

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

Detailed Description

Definition at line 27 of file SelectOptionsMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ILIAS\Setup\SelectOptionsMigration::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 36 of file SelectOptionsMigration.php.

References ILIAS\Setup\Migration\INFINITE.

                                                   : int
    {
        return Migration::INFINITE;
    }

getLabel()

ILIAS\Setup\SelectOptionsMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 31 of file SelectOptionsMigration.php.

                              : string
    {
        return "Grants each select option a permanent ID.";
    }

getPreconditions()

ILIAS\Setup\SelectOptionsMigration::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 41 of file SelectOptionsMigration.php.

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

getRemainingAmountOfSteps()

ILIAS\Setup\SelectOptionsMigration::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 62 of file SelectOptionsMigration.php.

References $res.

                                               : int
    {
        $res = $this->db->query(
            'SELECT COUNT(*) AS count FROM adv_mdf_enum WHERE position IS NULL'
        );

        $row = $this->db->fetchAssoc($res);
        return (int) $row['count'];
    }

prepare()

ILIAS\Setup\SelectOptionsMigration::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 SelectOptionsMigration.php.

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

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

Here is the call graph for this function:

step()

ILIAS\Setup\SelectOptionsMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 55 of file SelectOptionsMigration.php.

References $res.

                                                  : void
    {
        $res = $this->db->manipulate(
            'UPDATE adv_mdf_enum SET position = idx WHERE position IS NULL LIMIT 1'
        );
    }

Field Documentation

$db

ilDBInterface ILIAS\Setup\SelectOptionsMigration::$db

protected

Definition at line 29 of file SelectOptionsMigration.php.

---

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

• components/ILIAS/AdvancedMetaData/classes/Setup/SelectOptionsMigration.php