Inheritance diagram for ILIAS\Object\Setup\ilObjectTileImageMigration:

Collaboration diagram for ILIAS\Object\Setup\ilObjectTileImageMigration:

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

Private Member Functions
	removeDirectoryOrInform (string $directory, \stdClass $record)

	getFullPath (int $object_id, ?string $extension)

	cleanupTileInformationWithoutCorrespondingObject ()

	deleteTileImageInfoFromContainerSettings (int $id)

Private Attributes
ilResourceStorageMigrationHelper	$helper

FlavourBuilder	$flavour_builder

ilObjectTileImageFlavourDefinition	$flavour_definition

AdminInteraction	$admin_interaction

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

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file class.ilObjectTileImageMigration.php.

Member Function Documentation

◆ cleanupTileInformationWithoutCorrespondingObject()

ILIAS\Object\Setup\ilObjectTileImageMigration::cleanupTileInformationWithoutCorrespondingObject ( )

private

Definition at line 162 of file class.ilObjectTileImageMigration.php.

References $path, ILIAS\Object\Setup\ilObjectTileImageMigration\deleteTileImageInfoFromContainerSettings(), ILIAS\Object\Setup\ilObjectTileImageMigration\getFullPath(), and ILIAS\Object\Setup\ilObjectTileImageMigration\removeDirectoryOrInform().

Referenced by ILIAS\Object\Setup\ilObjectTileImageMigration\step().

                                                                        : void
     {
         $select_next_id = $this->helper->getDatabase()->query('
             SELECT
                 id,
                 value AS extension
             FROM container_settings
             WHERE keyword = "tile_image"
             ORDER BY id
             LIMIT 1;
         ');
         $next_record = $this->helper->getDatabase()->fetchObject($select_next_id);
 
         if ($next_record === null) {
             return;
         }
 
         $check_object_query = $this->helper->getDatabase()->queryF(
             'SELECT
                     count(obj_id) AS objs
                 FROM object_data
                 WHERE obj_id = %s;
             ',
             ['integer'],
             [$next_record->id]
         );
         $has_objects = $this->helper->getDatabase()->fetchObject($check_object_query);
         $path = $this->getFullPath($next_record->id, $next_record->extension);
 
         if ($has_objects->objs > 0) {
             return;
         }
 
         if (is_file($path)) {
             unlink($path);
         }
 
         $this->removeDirectoryOrInform(\dirname($path), $next_record);
         $this->deleteTileImageInfoFromContainerSettings($next_record->id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteTileImageInfoFromContainerSettings()

ILIAS\Object\Setup\ilObjectTileImageMigration::deleteTileImageInfoFromContainerSettings ( int $id )

private

Definition at line 203 of file class.ilObjectTileImageMigration.php.

Referenced by ILIAS\Object\Setup\ilObjectTileImageMigration\cleanupTileInformationWithoutCorrespondingObject(), and ILIAS\Object\Setup\ilObjectTileImageMigration\step().

                                                                       : void
     {
         $query_delete = $this->helper->getDatabase()->queryF('
             DELETE FROM container_settings
             WHERE keyword = "tile_image" AND id = %s
         ', ['integer'], [$id]);
         $this->helper->getDatabase()->execute($query_delete);
     }

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ILIAS\Object\Setup\ilObjectTileImageMigration::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 45 of file class.ilObjectTileImageMigration.php.

                                                    : int
     {
         return 10000;
     }

◆ getFullPath()

ILIAS\Object\Setup\ilObjectTileImageMigration::getFullPath	(	int	$object_id,
		?string	$extension
	)

private

Definition at line 148 of file class.ilObjectTileImageMigration.php.

References CLIENT_WEB_DIR.

Referenced by ILIAS\Object\Setup\ilObjectTileImageMigration\cleanupTileInformationWithoutCorrespondingObject(), and ILIAS\Object\Setup\ilObjectTileImageMigration\step().

                                                                     : string
     {
         return implode(
             DIRECTORY_SEPARATOR,
             [
                 CLIENT_WEB_DIR,
                 'obj_data',
                 'tile_image',
                 'tile_image_' . $object_id,
                 'tile_image.' . $extension
             ]
         );
     }

Here is the caller graph for this function:

◆ getLabel()

ILIAS\Object\Setup\ilObjectTileImageMigration::getLabel ( )

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

Implements ILIAS\Setup\Migration.

Definition at line 40 of file class.ilObjectTileImageMigration.php.

                               : string
     {
         return "Migration of Tile Images to the Resource Storage Service.";
     }

◆ getPreconditions()

ILIAS\Object\Setup\ilObjectTileImageMigration::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 50 of file class.ilObjectTileImageMigration.php.

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

◆ getRemainingAmountOfSteps()

ILIAS\Object\Setup\ilObjectTileImageMigration::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 212 of file class.ilObjectTileImageMigration.php.

References $r.

                                                : int
     {
         $query = $this->helper->getDatabase()->query('
             SELECT
                 count(container_settings.id) AS amount
             FROM container_settings
             WHERE container_settings.keyword = "tile_image"
         ');
         $r = $this->helper->getDatabase()->fetchObject($query);
 
         return (int) $r->amount;
     }

◆ prepare()

ILIAS\Object\Setup\ilObjectTileImageMigration::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 55 of file class.ilObjectTileImageMigration.php.

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

                                                      : void
     {
         $this->helper = new \ilResourceStorageMigrationHelper(
             new ilObjectTileImageStakeholder(),
             $environment
         );
         $this->admin_interaction = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
         $this->flavour_builder = $this->helper->getFlavourBuilder();
         $this->flavour_definition = new ilObjectTileImageFlavourDefinition();
     }

Here is the call graph for this function:

◆ removeDirectoryOrInform()

ILIAS\Object\Setup\ilObjectTileImageMigration::removeDirectoryOrInform	(	string	$directory,
		\stdClass	$record
	)

private

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

Referenced by ILIAS\Object\Setup\ilObjectTileImageMigration\cleanupTileInformationWithoutCorrespondingObject(), and ILIAS\Object\Setup\ilObjectTileImageMigration\step().

                                                                                   : void
     {
         if (!is_dir($directory)) {
             return;
         }
 
         $files = array_diff(scandir($directory), ['.', '..']);
         if (empty($files)) {
             rmdir($directory);
         } else {
             $file_list = implode(', ', $files);
             $this->admin_interaction->inform(
                 "The tile image for the object with the id $record->id was probably migrated successfully. "
                 . "However, the directory $directory could not be removed because it is not empty. "
                 . "Remaining files: $file_list. "
                 . 'You may want to verify that the tile image is visible for the object, and remove '
                 . 'the remaining files manually if they are not needed.'
             );
         }
     }

Here is the caller graph for this function:

◆ step()

ILIAS\Object\Setup\ilObjectTileImageMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 66 of file class.ilObjectTileImageMigration.php.

References $path, ILIAS\Object\Setup\ilObjectTileImageMigration\cleanupTileInformationWithoutCorrespondingObject(), ILIAS\Object\Setup\ilObjectTileImageMigration\deleteTileImageInfoFromContainerSettings(), ILIAS\Object\Setup\ilObjectTileImageMigration\getFullPath(), and ILIAS\Object\Setup\ilObjectTileImageMigration\removeDirectoryOrInform().

                                                   : void
     {
         $query_select = $this->helper->getDatabase()->query('
             SELECT
                 cs.id,
                 cs.value AS extension,
                 o.owner
             FROM container_settings AS cs
             INNER JOIN object_data AS o
                 ON cs.id = o.obj_id
             WHERE cs.keyword = "tile_image"
             ORDER BY cs.id
             LIMIT 1;
         ');
         $next_record = $this->helper->getDatabase()->fetchObject($query_select);
 
         if ($next_record === null) {
             $this->cleanupTileInformationWithoutCorrespondingObject();
             return;
         }
 
         $path = $this->getFullPath($next_record->id, $next_record->extension);
 
         if (is_readable(dirname(dirname($path)))
             && (!file_exists(dirname($path))
                 || is_readable(dirname($path)) && !file_exists($path))) {
             $this->deleteTileImageInfoFromContainerSettings($next_record->id);
             $this->admin_interaction->inform(
                 "The tile image for the object with the id {$next_record->id} and the path {$path} "
                 . 'could not be migrated. The entry linking the image to the object '
                 . 'was removed, the path to the image has been left on the system.'
             );
             return;
         }
 
         $rid = $this->helper->movePathToStorage(
             $path,
             $next_record->owner
         );
 
         if ($rid === null) {
             $this->deleteTileImageInfoFromContainerSettings($next_record->id);
             $this->admin_interaction->inform(
                 "The tile image for the object with the id {$next_record->id} and the path {$path} "
                 . 'could not be migrated. The database entry linking the image to the object '
                 . 'was removed, the path to the image has been left on the system.'
             );
             return;
         }
         $this->flavour_builder->get($rid, $this->flavour_definition, true);
 
         $this->helper->getDatabase()->update(
             'object_data',
             ['tile_image_rid' => ['text', $rid->serialize()]],
             ['obj_id' => ['integer', $next_record->id],]
         );
 
         $this->removeDirectoryOrInform(\dirname($path), $next_record);
         $this->deleteTileImageInfoFromContainerSettings($next_record->id);
     }

Here is the call graph for this function:

Field Documentation

◆ $admin_interaction

AdminInteraction ILIAS\Object\Setup\ilObjectTileImageMigration::$admin_interaction

private

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

◆ $flavour_builder

FlavourBuilder ILIAS\Object\Setup\ilObjectTileImageMigration::$flavour_builder

private

Definition at line 36 of file class.ilObjectTileImageMigration.php.

◆ $flavour_definition

ilObjectTileImageFlavourDefinition ILIAS\Object\Setup\ilObjectTileImageMigration::$flavour_definition

private

Definition at line 37 of file class.ilObjectTileImageMigration.php.

◆ $helper

ilResourceStorageMigrationHelper ILIAS\Object\Setup\ilObjectTileImageMigration::$helper

private

Definition at line 35 of file class.ilObjectTileImageMigration.php.

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

Services/Object/classes/Setup/class.ilObjectTileImageMigration.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cleanupTileInformationWithoutCorrespondingObject()

◆ deleteTileImageInfoFromContainerSettings()

◆ getDefaultAmountOfStepsPerRun()

◆ getFullPath()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ prepare()

◆ removeDirectoryOrInform()

◆ step()

Field Documentation

◆ $admin_interaction

◆ $flavour_builder

◆ $flavour_definition

◆ $helper