ilCourseCleanupActivationMigration Class Reference

Inheritance diagram for ilCourseCleanupActivationMigration:

Collaboration diagram for ilCourseCleanupActivationMigration:

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

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

Detailed Description

Definition at line 24 of file ilCourseCleanupActivationMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilCourseCleanupActivationMigration::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 33 of file ilCourseCleanupActivationMigration.php.

                                                   : int
    {
        return 10000;
    }

getLabel()

ilCourseCleanupActivationMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 28 of file ilCourseCleanupActivationMigration.php.

                              : string
    {
        return "Remove Duplicate Rows In Activation Table";
    }

getPreconditions()

ilCourseCleanupActivationMigration::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 38 of file ilCourseCleanupActivationMigration.php.

                                                              : array
    {
        return \ilResourceStorageMigrationHelper::getPreconditions();
    }

getRemainingAmountOfSteps()

ilCourseCleanupActivationMigration::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 85 of file ilCourseCleanupActivationMigration.php.

                                               : int
    {
        return $this->db->numRows(
            $this->db->query(
                'SELECT obj_id, parent_id FROM crs_items GROUP BY obj_id HAVING COUNT(*) > 1'
            )
        );
    }

prepare()

ilCourseCleanupActivationMigration::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 43 of file ilCourseCleanupActivationMigration.php.

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

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

step()

ilCourseCleanupActivationMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 48 of file ilCourseCleanupActivationMigration.php.

                                                  : void
    {
        $activation_data = $this->db->fetchObject(
            $this->db->query(
                'SELECT obj_id FROM crs_items' . PHP_EOL
                . 'GROUP BY obj_id HAVING COUNT(*) > 1 LIMIT 1'
            )
        );
 
        if ($activation_data === null) {
            return;
        }
 
        $parent_data = $this->db->fetchObject(
            $this->db->queryF(
                'SELECT parent FROM tree WHERE child=%s',
                [ilDBConstants::T_INTEGER],
                [$activation_data->obj_id]
            )
        );
 
        if ($parent_data === null) {
            $this->db->manipulateF(
                'DELETE FROM crs_items WHERE obj_id = %s',
                [ilDBConstants::T_INTEGER],
                [$activation_data->obj_id]
            );
            return;
        }
 
        $this->db->manipulateF(
            'DELETE FROM crs_items WHERE obj_id = %s AND parent_id != %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$activation_data->obj_id, $parent_data->parent]
        );
    }

References ilDBConstants\T_INTEGER.

Field Documentation

$db

ilDBInterface ilCourseCleanupActivationMigration::$db

private

Definition at line 26 of file ilCourseCleanupActivationMigration.php.

---

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

• components/ILIAS/Course/classes/Objectives/Setup/ilCourseCleanupActivationMigration.php