ILIAS\ILIASObject\Setup\MigrateTranslations Class Reference

Inheritance diagram for ILIAS\ILIASObject\Setup\MigrateTranslations:

Collaboration diagram for ILIAS\ILIASObject\Setup\MigrateTranslations:

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

Private Attributes
const	TESTS_PER_STEP = 100
ilDBInterface	$db

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

Detailed Description

Definition at line 27 of file MigrateTranslations.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

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

                                                   : int
    {
        return 1;
    }

getLabel()

ILIAS\ILIASObject\Setup\MigrateTranslations::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 33 of file MigrateTranslations.php.

                              : string
    {
        return 'Remove Table for Content Translation Information & Move Information to Translations';
    }

getPreconditions()

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

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

getRemainingAmountOfSteps()

ILIAS\ILIASObject\Setup\MigrateTranslations::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 106 of file MigrateTranslations.php.

Referenced by ILIAS\ILIASObject\Setup\MigrateTranslations\step().

                                               : int
    {
        if (!$this->db->tableExists('obj_content_master_lng')) {
            return 0;
        }

        $drop_table_steps = 0;
        if ($this->db->tableExists('obj_content_master_lng')) {
            $drop_table_steps = 1;
        }

        return ((int) ceil(
            $this->db->fetchObject(
                $this->db->query('
                SELECT DISTINCT COUNT(obj_id) as cnt
                FROM obj_content_master_lng
            ')
            )->cnt / self::TESTS_PER_STEP
        )) + $drop_table_steps;
    }

Here is the caller graph for this function:

prepare()

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

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

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

Here is the call graph for this function:

step()

ILIAS\ILIASObject\Setup\MigrateTranslations::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 55 of file MigrateTranslations.php.

References ILIAS\ILIASObject\Setup\MigrateTranslations\getRemainingAmountOfSteps(), null, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                  : void
    {
        if (!$this->db->tableExists('obj_content_master_lng')) {
            return;
        }
        $query_result = $this->db->query(
            'SELECT obj_id, master_lang, fallback_lang FROM obj_content_master_lng LIMIT ' . self::TESTS_PER_STEP
        );

        while (($row = $this->db->fetchObject($query_result)) !== null) {
            $this->db->update(
                'object_translation',
                [
                    'lang_base' => [\ilDBConstants::T_INTEGER, 1]
                ],
                [
                    'obj_id' => [\ilDBConstants::T_INTEGER, $row->obj_id],
                    'lang_code' => [\ilDBConstants::T_TEXT, $row->master_lang]
                ]
            );
            if ($row->fallback_lang !== null && $row->fallback_lang !== '') {
                $this->db->update(
                    'object_translation',
                    [
                        'lang_default' => [\ilDBConstants::T_INTEGER, 0]
                    ],
                    [
                        'obj_id' => [\ilDBConstants::T_INTEGER, $row->obj_id]
                    ]
                );
                $this->db->update(
                    'object_translation',
                    [
                        'lang_default' => [\ilDBConstants::T_INTEGER, 1]
                    ],
                    [
                        'obj_id' => [\ilDBConstants::T_INTEGER, $row->obj_id],
                        'lang_code' => [\ilDBConstants::T_TEXT, $row->fallback_lang]
                    ]
                );
            }
            $this->db->manipulate(
                "DELETE FROM obj_content_master_lng WHERE obj_id = {$row->obj_id}"
            );
        }

        if ($this->getRemainingAmountOfSteps() === 1) {
            $this->db->dropTable('obj_content_master_lng');
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ILIAS\ILIASObject\Setup\MigrateTranslations::$db

private

Definition at line 31 of file MigrateTranslations.php.

TESTS_PER_STEP

const ILIAS\ILIASObject\Setup\MigrateTranslations::TESTS_PER_STEP = 100

private

Definition at line 29 of file MigrateTranslations.php.

---

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

• components/ILIAS/ILIASObject/src/Setup/MigrateTranslations.php