ilBadgeTemplatesFilesMigration Class Reference

Inheritance diagram for ilBadgeTemplatesFilesMigration:

Collaboration diagram for ilBadgeTemplatesFilesMigration:

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
	getImagePath (int $id, string $image)
	getFilePath (int $a_id)
	createLegacyPathSegmentForBadgeTemplateId (int $id)
	inform (string $text, bool $force=false)
	error (string $text)

Private Attributes
const	TABLE_NAME = 'badge_image_template'
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.ilBadgeTemplatesFilesMigration.php.

Member Function Documentation

createLegacyPathSegmentForBadgeTemplateId()

ilBadgeTemplatesFilesMigration::createLegacyPathSegmentForBadgeTemplateId ( int  $id )

private

Definition at line 128 of file class.ilBadgeTemplatesFilesMigration.php.

References $id, and $path.

Referenced by getFilePath().

                                                                       : 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 . 'badgetmpl_' . $id;
    }

Here is the caller graph for this function:

error()

ilBadgeTemplatesFilesMigration::error ( string  $text )

private

Definition at line 169 of file class.ilBadgeTemplatesFilesMigration.php.

References null.

Referenced by step().

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

        $this->io->error($text);
    }

Here is the caller graph for this function:

getDefaultAmountOfStepsPerRun()

ilBadgeTemplatesFilesMigration::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.ilBadgeTemplatesFilesMigration.php.

                                                   : int
    {
        return 1000;
    }

getFilePath()

ilBadgeTemplatesFilesMigration::getFilePath ( int  $a_id )

private

Definition at line 123 of file class.ilBadgeTemplatesFilesMigration.php.

References CLIENT_ID, createLegacyPathSegmentForBadgeTemplateId(), and ILIAS_WEB_DIR.

Referenced by getImagePath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getImagePath()

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

private

Definition at line 115 of file class.ilBadgeTemplatesFilesMigration.php.

References getFilePath().

Referenced by step().

                                                         : string
    {
        $exp = explode('.', $image);
        $suffix = strtolower(array_pop($exp));

        return $this->getFilePath($id) . '/img' . $id . '.' . $suffix;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLabel()

ilBadgeTemplatesFilesMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

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

getPreconditions()

ilBadgeTemplatesFilesMigration::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.ilBadgeTemplatesFilesMigration.php.

References ilResourceStorageMigrationHelper\getPreconditions().

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

Here is the call graph for this function:

getRemainingAmountOfSteps()

ilBadgeTemplatesFilesMigration::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 150 of file class.ilBadgeTemplatesFilesMigration.php.

References $res.

                                               : 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);
    }

inform()

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

private

Definition at line 160 of file class.ilBadgeTemplatesFilesMigration.php.

References null.

Referenced by step().

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

        $this->io->inform($text);
    }

Here is the caller graph for this function:

prepare()

ilBadgeTemplatesFilesMigration::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.ilBadgeTemplatesFilesMigration.php.

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

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

Here is the call graph for this function:

step()

ilBadgeTemplatesFilesMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

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

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

                                                  : 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 image template 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 image template ' .
                        "file $image_path for id $id to the storage service."
                    );
                } else {
                    $this->inform(
                        "IRSS identification for badge image template with id $id: {$identification->serialize()}",
                        true
                    );
                }
            } catch (Throwable $e) {
                $this->error("Failed to move badge image template 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]]
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilBadgeTemplatesFilesMigration::$helper

private

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

$io

IOWrapper ilBadgeTemplatesFilesMigration::$io = null

private

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

Referenced by prepare().

TABLE_NAME

const ilBadgeTemplatesFilesMigration::TABLE_NAME = 'badge_image_template'

private

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

---

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

• components/ILIAS/Badge/classes/Setup/class.ilBadgeTemplatesFilesMigration.php