ilObjCloudModuleMigration Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjCloudModuleMigration:

Collaboration diagram for ilObjCloudModuleMigration:

Public Member Functions
	getLabel ()
	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...
	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...
	getPreconditions (Environment $environment)
	prepare (Environment $environment)
	Prepare the migration by means of some environment. More...
	step (Environment $environment)
	Run one step of the migration. More...

Protected Member Functions
	getCloudReferencesQuery ()

Protected Attributes
ilDBInterface	$db

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 24 of file ilObjCloudModuleMigration.php.

Member Function Documentation

getCloudReferencesQuery()

ilObjCloudModuleMigration::getCloudReferencesQuery ( )

protected

Definition at line 74 of file ilObjCloudModuleMigration.php.

                                                : ilDBStatement
    {
        return $this->db->query("
                    SELECT ref_id 
                    FROM object_data, object_reference 
                    WHERE object_data.type = 'cld' AND object_data.obj_id = object_reference.obj_id");
    }

getDefaultAmountOfStepsPerRun()

ilObjCloudModuleMigration::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 ilObjCloudModuleMigration.php.

                                                   : int
    {
        return Migration::INFINITE;
    }

getLabel()

ilObjCloudModuleMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 28 of file ilObjCloudModuleMigration.php.

                              : string
    {
        return 'ilObjCloudModule Data Removal. Attention, this deletes all Data of the Cloud Module from the Repository';
    }

getPreconditions()

ilObjCloudModuleMigration::getPreconditions

(

Environment

$environment

)

Returns

ilDatabaseUpdatedObjective[]|ilIniFilesLoadedObjective[]

Implements ILIAS\Setup\Migration.

Definition at line 50 of file ilObjCloudModuleMigration.php.

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

getRemainingAmountOfSteps()

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

                                               : int
    {
        if ($this->db->fetchObject($this->getCloudReferencesQuery())) {
            return 1;
        } else {
            return 0;
        }
    }

prepare()

ilObjCloudModuleMigration::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 58 of file ilObjCloudModuleMigration.php.

References ilContext\CONTEXT_CRON, ILIAS\Setup\Environment\getResource(), ilContext\init(), and ilInitialisation\initILIAS().

                                                     : void
    {
        //This is necessary for using ilObjects delete function to remove existing objects
        ilContext::init(ilContext::CONTEXT_CRON);
        ilInitialisation::initILIAS();
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

Here is the call graph for this function:

step()

ilObjCloudModuleMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 66 of file ilObjCloudModuleMigration.php.

                                                  : void
    {
        while ($result = $this->db->fetchObject($this->getCloudReferencesQuery())) {
            $cloud_object = new ilObjCloud((int) $result->ref_id);
            $cloud_object->delete();
        }
    }

Field Documentation

$db

ilDBInterface ilObjCloudModuleMigration::$db

protected

Definition at line 26 of file ilObjCloudModuleMigration.php.

---

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

• Modules/Cloud/classes/Setup/ilObjCloudModuleMigration.php