Inheritance diagram for ilBadgesFilesMigration:

Collaboration diagram for ilBadgesFilesMigration:

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

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

Private Member Functions
	getImagePath (int $id, string $image)

	getFilePath (int $a_id)

	createLegacyPathSegmentForBadgeId (int $id)

	inform (string $text, bool $force=false)

	error (string $text)

Private Attributes
const	TABLE_NAME = 'badge_badge'

ilResourceStorageMigrationHelper	$helper

IOWrapper	$io = null

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

Detailed Description

Definition at line 26 of file class.ilBadgesFilesMigration.php.

Member Function Documentation

◆ createLegacyPathSegmentForBadgeId()

ilBadgesFilesMigration::createLegacyPathSegmentForBadgeId ( int $id )

private

Definition at line 131 of file class.ilBadgesFilesMigration.php.

                                                               : string
    {
        $path = [];
        $found = false;
        $num = $id;
        $path_string = '';
        for ($i = 3; $i > 0; $i--) {
            $factor = 100 ** $i;
            if (($tmp = (int) ($num / $factor)) || $found) {
                $path[] = $tmp;
                $num %= $factor;
                $found = true;
            }
        }
 
        if (count($path)) {
            $path_string = (implode('/', $path) . '/');
        }
 
        return $path_string . 'badge_' . $id;
    }

References $id, and $path.

Referenced by getFilePath().

Here is the caller graph for this function:

◆ error()

ilBadgesFilesMigration::error ( string $text )

private

Definition at line 182 of file class.ilBadgesFilesMigration.php.

                                        : void
    {
        if ($this->io === null) {
            return;
        }
 
        $this->io->error($text);
    }

Referenced by step().

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

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

                                                   : int
    {
        return 1000;
    }

◆ getFilePath()

ilBadgesFilesMigration::getFilePath ( int $a_id )

private

Definition at line 126 of file class.ilBadgesFilesMigration.php.

                                           : string
    {
        return ILIAS_ABSOLUTE_PATH . '/' . ILIAS_WEB_DIR . '/' . CLIENT_ID . '/sec/ilBadge/' . $this->createLegacyPathSegmentForBadgeId($a_id);
    }

References CLIENT_ID, createLegacyPathSegmentForBadgeId(), and ILIAS_WEB_DIR.

Referenced by getImagePath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePath()

ilBadgesFilesMigration::getImagePath	(	int	$id,
		string	$image
	)

private

Definition at line 118 of file class.ilBadgesFilesMigration.php.

                                                         : string
    {
        $exp = explode('.', $image);
        $suffix = strtolower(array_pop($exp));
 
        return $this->getFilePath($id) . '/img' . $id . '.' . $suffix;
    }

References $id, and getFilePath().

Referenced by step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLabel()

ilBadgesFilesMigration::getLabel ( )

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

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return 'Migration of files of badges to the resource storage service.';
    }

◆ getPreconditions()

ilBadgesFilesMigration::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 43 of file class.ilBadgesFilesMigration.php.

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

References ilResourceStorageMigrationHelper\getPreconditions().

Here is the call graph for this function:

◆ getRemainingAmountOfSteps()

ilBadgesFilesMigration::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 153 of file class.ilBadgesFilesMigration.php.

                                               : int
    {
        $res = $this->helper->getDatabase()->query(
            'SELECT COUNT(id) as amount FROM ' . self::TABLE_NAME . " WHERE image_rid IS NULL OR image_rid = ''"
        );
        $row = $this->helper->getDatabase()->fetchObject($res);
 
        return (int) ($row->amount ?? 0);
    }

References $res.

◆ getRevisionNameCallback()

ilBadgesFilesMigration::getRevisionNameCallback ( )

Returns: Closure(string): string

Definition at line 166 of file class.ilBadgesFilesMigration.php.

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

◆ inform()

ilBadgesFilesMigration::inform	(	string	$text,
		bool	$force = `false`
	)

private

Definition at line 173 of file class.ilBadgesFilesMigration.php.

                                                              : void
    {
        if ($this->io === null || (!$force && !$this->io->isVerbose())) {
            return;
        }
 
        $this->io->inform($text);
    }

Referenced by step().

Here is the caller graph for this function:

◆ prepare()

ilBadgesFilesMigration::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 48 of file class.ilBadgesFilesMigration.php.

                                                     : void
    {
        $this->helper = new ilResourceStorageMigrationHelper(
            new ilBadgeFileStakeholder(),
            $environment
        );
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        if ($io instanceof IOWrapper) {
            $this->io = $io;
        }
    }

References $io, and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

◆ step()

ilBadgesFilesMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 60 of file class.ilBadgesFilesMigration.php.

                                                  : void
    {
        $this->helper->getDatabase()->setLimit(1);
        $res = $this->helper->getDatabase()->query(
            'SELECT id, image, image_rid FROM ' . self::TABLE_NAME . " WHERE image_rid IS NULL OR image_rid = ''"
        );
        $row = $this->helper->getDatabase()->fetchObject($res);
        if (!($row instanceof stdClass)) {
            return;
        }
 
        $id = (int) $row->id;
        $image = $row->image;
 
        if ($image !== '' && $image !== null) {
            $image_path = $this->getImagePath($id, $image);
 
            try {
                $this->inform("Trying to move badge file $image_path for id $id to the storage service.");
                $identification = $this->helper->movePathToStorage($image_path, ResourceCollection::NO_SPECIFIC_OWNER);
                $this->inform('Migration proceeded without error.');
                if ($identification === null) {
                    $this->error(
                        'IRSS returned NULL as identification when trying to move badge ' .
                        "file $image_path for id $id to the storage service."
                    );
                } else {
                    $this->inform("IRSS identification for badge with id $id: {$identification->serialize()}", true);
                }
            } catch (Throwable $e) {
                $this->error("Failed to move badge file {$image_path} for id {$id} to the storage service with exception: {$e->getMessage()}");
                $this->error($e->getTraceAsString());
                throw $e;
            }
 
            if ($identification === null) {
                $identification = '-';
            } else {
                $identification = $identification->serialize();
            }
 
            $this->helper->getDatabase()->update(
                self::TABLE_NAME,
                [
                    'image_rid' => [ilDBConstants::T_TEXT, $identification],
                    'image' => [ilDBConstants::T_TEXT, null]
                ],
                ['id' => [ilDBConstants::T_INTEGER, $id]]
            );
        } else {
            $this->inform(
                'Cannot migrate badge with id ' . $id
                . ' (table: ' . self::TABLE_NAME . ') because no image is set.',
                true
            );
        }
    }

References Vendor\Package\$e, $id, $res, error(), getImagePath(), if, inform(), ILIAS\Repository\int(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Here is the call graph for this function:

Field Documentation

◆ $helper

ilResourceStorageMigrationHelper ilBadgesFilesMigration::$helper

private

Definition at line 30 of file class.ilBadgesFilesMigration.php.

◆ $io

IOWrapper ilBadgesFilesMigration::$io = null

private

Definition at line 31 of file class.ilBadgesFilesMigration.php.

Referenced by prepare().

◆ TABLE_NAME

const ilBadgesFilesMigration::TABLE_NAME = 'badge_badge'

private

Definition at line 28 of file class.ilBadgesFilesMigration.php.

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

components/ILIAS/Badge/classes/Setup/class.ilBadgesFilesMigration.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createLegacyPathSegmentForBadgeId()

◆ error()

◆ getDefaultAmountOfStepsPerRun()

◆ getFilePath()

◆ getImagePath()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ getRevisionNameCallback()

◆ inform()

◆ prepare()

◆ step()

Field Documentation

◆ $helper

◆ $io

◆ TABLE_NAME