ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration Class Reference

Inheritance diagram for ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration:

Collaboration diagram for ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration:

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
	migrateIntroductions (\ilDBStatement $select_page_statement)
	migrateConcludingRemarks (\ilDBStatement $select_page_statement, int $max_steps)
	createPageWithNextId (int $test_obj_id, \stdClass $row)

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

Member Function Documentation

createPageWithNextId()

ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::createPageWithNextId ( int  $test_obj_id, \stdClass  $row  )

private

Definition at line 189 of file CloneIntroductionAndClosingRemarksMigration.php.

                                                                           : int
    {
        $query = $this->db->query('SELECT max(page_id) as last_id FROM page_object WHERE parent_type="tst"');
        $last_row = $this->db->fetchObject($query);
        try {
            $this->db->insert(
                'page_object',
                [
                    'page_id' => ['integer', $last_row->last_id + 1],
                    'parent_id' => ['integer', $test_obj_id],
                    'lang' => ['text', $row->lang],
                    'content' => ['clob', $row->content],
                    'parent_type' => ['text', $row->parent_type],
                    'create_user' => ['integer', $row->create_user],
                    'last_change_user' => ['integer', $row->last_change_user],
                    'active' => ['integer', $row->active],
                    'activation_start' => ['timestamp', $row->activation_start],
                    'activation_end' => ['timestamp', $row->activation_end],
                    'show_activation_info' => ['integer', $row->show_activation_info],
                    'inactive_elements' => ['integer', $row->inactive_elements],
                    'int_links' => ['integer', $row->int_links],
                    'created' => ['timestamp', \ilUtil::now()],
                    'last_change' => ['timestamp', \ilUtil::now()],
                    'is_empty' => ['integer', $row->is_empty]
                ]
            );
        } catch (ilDatabaseException $e) {
            $this->createPageWithNextId($row);
        }
 
        return $last_row->last_id + 1;
    }

References Vendor\Package\$e, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\createPageWithNextId(), and ilUtil\now().

Referenced by ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\createPageWithNextId(), ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\migrateConcludingRemarks(), and ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\migrateIntroductions().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultAmountOfStepsPerRun()

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

                                                   : int
    {
        return 1;
    }

getLabel()

ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 33 of file CloneIntroductionAndClosingRemarksMigration.php.

                              : string
    {
        return 'Fix missing clones for Introduction and Concluding Remarks.';
    }

getPreconditions()

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

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

getRemainingAmountOfSteps()

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

                                               : int
    {
        $result_intro = $this->db->query('
            SELECT COUNT(test_id) as cnt
            FROM tst_tests
            WHERE NOT introduction_page_id IS NULL
                AND introduction_page_id IN
                (SELECT introduction_page_id FROM tst_tests GROUP BY introduction_page_id HAVING COUNT(introduction_page_id) > 1)
        ');
        $row_intro = $this->db->fetchObject($result_intro);
 
        $result_conclusion = $this->db->query('
            SELECT COUNT(test_id) as cnt
            FROM tst_tests
            WHERE NOT concluding_remarks_page_id IS NULL
                AND concluding_remarks_page_id  in
                (SELECT concluding_remarks_page_id FROM tst_tests GROUP BY concluding_remarks_page_id HAVING COUNT(concluding_remarks_page_id) > 1)
        ');
        $row_conclusion = $this->db->fetchObject($result_conclusion);
 
        return (int) ceil(($row_intro->cnt + $row_conclusion->cnt) / self::TESTS_PER_STEP);
    }

migrateConcludingRemarks()

ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::migrateConcludingRemarks ( \ilDBStatement  $select_page_statement, int  $max_steps  )

private

Definition at line 141 of file CloneIntroductionAndClosingRemarksMigration.php.

                                                                                                    : void
    {
        $result = $this->db->query(
            '
            SELECT test_id, obj_fi, concluding_remarks_page_id
            FROM tst_tests
            WHERE NOT concluding_remarks_page_id IS NULL
                AND concluding_remarks_page_id IN
                (SELECT concluding_remarks_page_id FROM tst_tests GROUP BY concluding_remarks_page_id HAVING COUNT(concluding_remarks_page_id) > 1)
            ORDER BY concluding_remarks_page_id
            LIMIT ' . $max_steps
        );
 
        $first_row = $this->db->fetchObject($result);
        if ($first_row === null) {
            return;
        }
 
        $concluding_remarks_to_clone = $this->db->fetchObject(
            $this->db->execute(
                $select_page_statement,
                [$first_row->concluding_remarks_page_id]
            )
        );
        while (($row = $this->db->fetchObject($result)) !== null) {
            if ($row->concluding_remarks_page_id !== $concluding_remarks_to_clone?->page_id) {
                $concluding_remarks_to_clone = $this->db->fetchObject(
                    $this->db->execute(
                        $select_page_statement,
                        [$row->concluding_remarks_page_id]
                    )
                );
                continue;
            }
 
            $new_page_id = $this->createPageWithNextId($row->obj_fi, $concluding_remarks_to_clone);
            $this->db->update(
                'tst_tests',
                [
                    'concluding_remarks_page_id' => [\ilDBConstants::T_INTEGER, $new_page_id]
                ],
                [
                    'test_id' => [\ilDBConstants::T_INTEGER, $row->test_id]
                ]
            );
        }
    }

References ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\createPageWithNextId(), and ilDBConstants\T_INTEGER.

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

Here is the call graph for this function:

Here is the caller graph for this function:

migrateIntroductions()

ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::migrateIntroductions ( \ilDBStatement  $select_page_statement )

private

Definition at line 91 of file CloneIntroductionAndClosingRemarksMigration.php.

                                                                                : int
    {
        $result = $this->db->query(
            '
            SELECT test_id, obj_fi, introduction_page_id
            FROM tst_tests
            WHERE NOT introduction_page_id IS NULL
                AND introduction_page_id IN
                (SELECT introduction_page_id FROM tst_tests GROUP BY introduction_page_id HAVING COUNT(introduction_page_id) > 1)
            ORDER BY introduction_page_id
            LIMIT ' . self::TESTS_PER_STEP
        );
 
        $first_row = $this->db->fetchObject($result);
        if ($first_row === null) {
            return self::TESTS_PER_STEP;
        }
 
        $introduction_to_clone = $this->db->fetchObject(
            $this->db->execute(
                $select_page_statement,
                [$first_row->introduction_page_id]
            )
        );
        while (($row = $this->db->fetchObject($result)) !== null) {
            if ($row->introduction_page_id !== $introduction_to_clone?->page_id) {
                $introduction_to_clone = $this->db->fetchObject(
                    $this->db->execute(
                        $select_page_statement,
                        [$row->introduction_page_id]
                    )
                );
                continue;
            }
 
            $new_page_id = $this->createPageWithNextId($row->obj_fi, $introduction_to_clone);
            $this->db->update(
                'tst_tests',
                [
                    'introduction_page_id' => [\ilDBConstants::T_INTEGER, $new_page_id]
                ],
                [
                    'test_id' => [\ilDBConstants::T_INTEGER, $row->test_id]
                ]
            );
        }
 
        return self::TESTS_PER_STEP - $result->numRows();
    }

References ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\createPageWithNextId(), ilDBConstants\T_INTEGER, and ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\TESTS_PER_STEP.

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

Here is the call graph for this function:

Here is the caller graph for this function:

prepare()

ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::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 CloneIntroductionAndClosingRemarksMigration.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\CloneIntroductionAndClosingRemarksMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 55 of file CloneIntroductionAndClosingRemarksMigration.php.

                                                  : void
    {
        $select_page_statement = $this->db->prepare(
            'SELECT * FROM page_object WHERE parent_type = "tst" AND page_id = ?',
            [\ilDBConstants::T_INTEGER]
        );
 
        $max_steps = $this->migrateIntroductions($select_page_statement);
        $this->migrateConcludingRemarks($select_page_statement, $max_steps);
 
        $this->db->free($select_page_statement);
    }

References ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\migrateConcludingRemarks(), ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\migrateIntroductions(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

Field Documentation

$db

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

private

Definition at line 31 of file CloneIntroductionAndClosingRemarksMigration.php.

TESTS_PER_STEP

const ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration::TESTS_PER_STEP = 100

private

Definition at line 29 of file CloneIntroductionAndClosingRemarksMigration.php.

Referenced by ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\migrateIntroductions().

---

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

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