Inheritance diagram for ilHTLMMigration:

Collaboration diagram for ilHTLMMigration:

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

	getFileNameCallback (string $pattern)

	getRevisionNameCallback ()

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

Protected Member Functions
	determineStartFile (string $lm_path, string $start_file)
	Learning modules without a stored start file relied on a fallback to index.html or index.htm before the migration. More...

	buildBasePath (int $object_id)

Protected Attributes
ilResourceStorageMigrationHelper	$helper

Private Member Functions
	recursiveRmDir (string $path)

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

Detailed Description

Definition at line 25 of file class.ilHTLMMigration.php.

Member Function Documentation

◆ buildBasePath()

ilHTLMMigration::buildBasePath ( int $object_id )

protected

Definition at line 127 of file class.ilHTLMMigration.php.

                                                    : string
    {
        return CLIENT_WEB_DIR . '/lm_data/lm_' . $object_id;
    }

References CLIENT_WEB_DIR.

Referenced by step().

Here is the caller graph for this function:

◆ determineStartFile()

ilHTLMMigration::determineStartFile	(	string	$lm_path,
		string	$start_file
	)

protected

Learning modules without a stored start file relied on a fallback to index.html or index.htm before the migration.

Persist that fallback, the stored start file wins.

Definition at line 95 of file class.ilHTLMMigration.php.

                                                                              : string
    {
        if ($start_file !== '') {
            return $start_file;
        }
        foreach (['index.html', 'index.htm'] as $candidate) {
            if (is_file($lm_path . '/' . $candidate)) {
                return $candidate;
            }
        }
        return '';
    }

Referenced by step().

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ilHTLMMigration::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 34 of file class.ilHTLMMigration.php.

                                                   : int
    {
        return 10000;
    }

◆ getFileNameCallback()

ilHTLMMigration::getFileNameCallback ( string $pattern )

Definition at line 132 of file class.ilHTLMMigration.php.

                                                        : Closure
    {
        return static function (string $file_name) use ($pattern): string {
            if (preg_match($pattern, $file_name, $matches)) {
                return $matches[1] ?? $file_name;
            }
            return $file_name;
        };
    }

References $pattern.

◆ getLabel()

ilHTLMMigration::getLabel ( )

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

Implements ILIAS\Setup\Migration.

Definition at line 29 of file class.ilHTLMMigration.php.

                              : string
    {
        return 'Migration of HTML Learning Modules to the Resource Storage Service.';
    }

◆ getPreconditions()

ilHTLMMigration::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 39 of file class.ilHTLMMigration.php.

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

References ilResourceStorageMigrationHelper\getPreconditions().

Here is the call graph for this function:

◆ getRemainingAmountOfSteps()

ilHTLMMigration::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 117 of file class.ilHTLMMigration.php.

                                               : int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT COUNT(id) AS amount FROM file_based_lm WHERE rid IS NULL OR rid = ''"
        );
        $d = $this->helper->getDatabase()->fetchObject($r) ?? new stdClass();
 
        return (int) ($d->amount ?? 0);
    }

References Vendor\Package\$d.

◆ getRevisionNameCallback()

ilHTLMMigration::getRevisionNameCallback ( )

Definition at line 142 of file class.ilHTLMMigration.php.

                                             : Closure
    {
        return static function (string $file_name): string {
            return md5($file_name);
        };
    }

◆ prepare()

ilHTLMMigration::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 44 of file class.ilHTLMMigration.php.

                                                     : void
    {
        $this->helper = new ilResourceStorageMigrationHelper(
            new ilHTLMStakeholder(),
            $environment
        );
    }

◆ recursiveRmDir()

ilHTLMMigration::recursiveRmDir ( string $path )

private

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

                                                 : void
    {
        // recursively remove directory
        $files = array_diff(scandir($path), ['.', '..']);
        foreach ($files as $file) {
            (is_dir("$path/$file")) ? $this->recursiveRmDir("$path/$file") : unlink("$path/$file");
        }
    }

References $files, and recursiveRmDir().

Referenced by recursiveRmDir(), and step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ step()

ilHTLMMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 52 of file class.ilHTLMMigration.php.

                                                  : void
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT id, startfile FROM file_based_lm WHERE rid IS NULL OR rid = '' LIMIT 1;"
        );
 
        $d = $this->helper->getDatabase()->fetchObject($r);
        $object_id = (int) ($d->id ?? null);
 
        $resource_owner_id = (int) ($d->owner_id ?? 6); // TODO JOIN
 
        $lm_path = $this->buildBasePath($object_id);
        $start_file = $this->determineStartFile($lm_path, (string) ($d->startfile ?? ''));
 
        $rid = $this->helper->moveDirectoryToContainerResource(
            $lm_path,
            $resource_owner_id
        );
 
        if ($rid !== null) {
            $this->helper->getDatabase()->update(
                'file_based_lm',
                [
                    'rid' => ['text', $rid->serialize()],
                    'startfile' => ['text', $start_file],
                ],
                ['id' => ['integer', $object_id],]
            );
 
            $this->recursiveRmDir($lm_path);
        } else {
            $this->helper->getDatabase()->update(
                'file_based_lm',
                ['rid' => ['text', '-']],
                ['id' => ['integer', $object_id],]
            );
        }
    }

References Vendor\Package\$d, buildBasePath(), determineStartFile(), ILIAS\Repository\int(), and recursiveRmDir().

Here is the call graph for this function:

Field Documentation

◆ $helper

ilResourceStorageMigrationHelper ilHTLMMigration::$helper

protected

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

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

components/ILIAS/HTMLLearningModule/classes/Setup/Migrations/class.ilHTLMMigration.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildBasePath()

◆ determineStartFile()

◆ getDefaultAmountOfStepsPerRun()

◆ getFileNameCallback()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ getRevisionNameCallback()

◆ prepare()

◆ recursiveRmDir()

◆ step()

Field Documentation

◆ $helper