Class ilStorageHandlerV1Migration. More...

Inheritance diagram for ilStorageHandlerV1Migration:

Collaboration diagram for ilStorageHandlerV1Migration:

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

	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

Public Member Functions inherited from ILIAS\Setup\Migration
	step (Environment $environment)
	Run one step of the migration. More...

Protected Attributes
	$iterator

	$database

	$migrator

	$resource_builder

	$data_dir

	$from = 'fsv1'

	$to = 'fsv2'

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

Detailed Description

Class ilStorageHandlerV1Migration.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 27 of file class.ilStorageHandlerV1Migration.php.

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

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

Returns: int

Implements ILIAS\Setup\Migration.

Definition at line 58 of file class.ilStorageHandlerV1Migration.php.

                                                     : int
     {
         return 10000;
     }

◆ getLabel()

ilStorageHandlerV1Migration::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 53 of file class.ilStorageHandlerV1Migration.php.

                                : string
     {
         return 'ilStorageHandlerV1Migration';
     }

◆ getPreconditions()

ilStorageHandlerV1Migration::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 63 of file class.ilStorageHandlerV1Migration.php.

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

◆ getRemainingAmountOfSteps()

ilStorageHandlerV1Migration::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

Returns: int

Implements ILIAS\Setup\Migration.

Definition at line 139 of file class.ilStorageHandlerV1Migration.php.

References $d.

                                                 : int
     {
         $r = $this->database->queryF(
             "SELECT COUNT(rid) as old_storage FROM il_resource WHERE storage_id != %s",
             ['text'],
             [$this->to]
         );
         $d = $this->database->fetchObject($r);
 
         return (int) ($d->old_storage ?? 0);
     }

◆ prepare()

ilStorageHandlerV1Migration::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 72 of file class.ilStorageHandlerV1Migration.php.

References $client_id, $d, $data_dir, $database, $DIC, Vendor\Package\$f, $GLOBALS, $i, ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Migration\step().

                                                       : void
     {
         $ilias_ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
         $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
 
         $data_dir = $ilias_ini->readVariable('clients', 'datadir');
         $this->data_dir = $data_dir . "/" . $client_id;
 
         $configuration = new LocalConfig("{$data_dir}/{$client_id}");
         $f = new FlySystemFilesystemFactory();
         $filesystem = $f->getLocal($configuration);
 
         $this->database = $environment->getResource(Environment::RESOURCE_DATABASE);
 
         // ATTENTION: This is a total abomination. It only exists to allow the db-
         // update to run. This is a memento to the fact, that dependency injection
         // is something we want. Currently, every component could just service
         // locate the whole world via the global $DIC.
         $DIC = $GLOBALS["DIC"] ?? [];
         $GLOBALS["DIC"] = new Container();
         $GLOBALS["DIC"]["ilDB"] = $this->database;
         $GLOBALS["ilDB"] = $this->database;
 
         $storage_handler_factory = new StorageHandlerFactory([
             new MaxNestingFileSystemStorageHandler($filesystem, Location::STORAGE),
             new FileSystemStorageHandler($filesystem, Location::STORAGE)
         ]);
 
         $this->resource_builder = new ResourceBuilder(
             $storage_handler_factory,
             new RevisionDBRepository($this->database),
             new ResourceDBRepository($this->database),
             new InformationDBRepository($this->database),
             new StakeholderDBRepository($this->database),
             new LockHandlerilDB($this->database),
             new FileNamePolicyStack()
         );
 
         $this->migrator = new Migrator(
             $storage_handler_factory,
             $this->resource_builder,
             $this->database,
             $this->data_dir
         );
 
     }