Inheritance diagram for ilFileObjectToStorageMigration:

Collaboration diagram for ilFileObjectToStorageMigration:

Public Member Functions
	getLabel ()

	getDefaultAmountOfStepsPerRun ()

	getPreconditions (Environment $environment)

	prepare (Environment $environment)

	step (Environment $environment)

	getRemainingAmountOfSteps ()

Data Fields
const	MIGRATION_LOG_CSV = "migration_log.csv"

Protected Member Functions
	showConfirmation (Environment $environment)

Protected Attributes
bool	$prepared = false

ilFileObjectToStorageMigrationRunner	$runner

ilDBInterface	$database

Private Attributes
const	FILE_PATH_REGEX = '/.\/file_([\d])$/'

ilFileObjectToStorageMigrationHelper	$helper = null

bool	$confirmed = false

Detailed Description

Definition at line 24 of file class.ilFileObjectToStorageMigration.php.

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

ilFileObjectToStorageMigration::getDefaultAmountOfStepsPerRun ( )

Definition at line 46 of file class.ilFileObjectToStorageMigration.php.

◆ getLabel()

ilFileObjectToStorageMigration::getLabel ( )

Definition at line 38 of file class.ilFileObjectToStorageMigration.php.

                               : string
     {
         return "Migration of File-Objects to Storage service";
     }

◆ getPreconditions()

ilFileObjectToStorageMigration::getPreconditions ( Environment $environment )

Definition at line 54 of file class.ilFileObjectToStorageMigration.php.

References ilResourceStorageMigrationHelper\getPreconditions().

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

Here is the call graph for this function:

◆ getRemainingAmountOfSteps()

ilFileObjectToStorageMigration::getRemainingAmountOfSteps ( )

Definition at line 108 of file class.ilFileObjectToStorageMigration.php.

References $d.

                                                : int
     {
         $r = $this->database->query("SELECT COUNT(file_id) AS amount FROM file_data WHERE rid IS NULL OR rid = '';");
         $d = $this->database->fetchObject($r);
 
         return (int) $d->amount;
     }

◆ prepare()

ilFileObjectToStorageMigration::prepare ( Environment $environment )

Definition at line 62 of file class.ilFileObjectToStorageMigration.php.

References $DIC, and Vendor\Package\$f.

                                                      : void
     {
         $irss_helper = new ilResourceStorageMigrationHelper(
             new ilObjFileStakeholder(),
             $environment
         );
 
         $legacy_files_dir = $irss_helper->getClientDataDir() . "/ilFile";
         $this->helper = new ilFileObjectToStorageMigrationHelper(
             $irss_helper
         );
 
         global $DIC;
         $DIC['ilDB'] = $irss_helper->getDatabase(); // needed inside some method calls to ILIAS
 
         $storage_configuration = new LocalConfig($irss_helper->getClientDataDir());
         $f = new FlySystemFilesystemFactory();
 
         $this->runner = new ilFileObjectToStorageMigrationRunner(
             $f->getLocal($storage_configuration),
             $irss_helper,
             self::MIGRATION_LOG_CSV
         );
 
         $this->database = $irss_helper->getDatabase();
     }

◆ showConfirmation()

ilFileObjectToStorageMigration::showConfirmation ( Environment $environment )

protected

Parameters

Environment $environment

Returns: void

Definition at line 120 of file class.ilFileObjectToStorageMigration.php.

References ILIAS\Setup\Environment\getResource().

Referenced by step().

                                                                  : void
     {
         if (!$this->confirmed) {
             $io = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
             $this->confirmed = $io->confirmExplicit(
                 'The migration of File-Objects should be done in ILIAS 7 not 8, see Modules/File/classes/Setup/MISSING_MIGRATION.md, type "Understood" to proceed',
                 'Understood'
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ step()

ilFileObjectToStorageMigration::step ( Environment $environment )

Definition at line 92 of file class.ilFileObjectToStorageMigration.php.

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

                                                   : void
     {
         if ($this->helper === null) {
             $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION)->inform(
                 "No migration possible, base-directory not found."
             );
             return;
         }
         $this->showConfirmation($environment);
         $item = $this->helper->getNext();
         $this->runner->migrate($item);
     }