Inheritance diagram for ILIAS\User\Setup\MigrateNewAccountAttachments:

Collaboration diagram for ILIAS\User\Setup\MigrateNewAccountAttachments:

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

	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 Attributes
ilResourceStorageMigrationHelper	$helper = null

int	$root_user_id

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

Detailed Description

Definition at line 25 of file MigrateNewAccountAttachments.php.

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

ILIAS\User\Setup\MigrateNewAccountAttachments::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 35 of file MigrateNewAccountAttachments.php.

◆ getLabel()

ILIAS\User\Setup\MigrateNewAccountAttachments::getLabel ( )

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

Implements ILIAS\Setup\Migration.

Definition at line 30 of file MigrateNewAccountAttachments.php.

                              : string
    {
        return 'Migrate New Account Mail Attachments to IRSS';
    }

◆ getPreconditions()

ILIAS\User\Setup\MigrateNewAccountAttachments::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 40 of file MigrateNewAccountAttachments.php.

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

◆ getRemainingAmountOfSteps()

ILIAS\User\Setup\MigrateNewAccountAttachments::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 108 of file MigrateNewAccountAttachments.php.

                                               : int
    {
        return $this->helper->getDatabase()->fetchObject(
            $this->helper->getDatabase()->query(
                'SELECT COUNT(*) cnt FROM mail_template WHERE att_file IS NOT NULL AND type = "nacc"'
            )
        )->cnt;
    }

◆ prepare()

ILIAS\User\Setup\MigrateNewAccountAttachments::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 45 of file MigrateNewAccountAttachments.php.

                                                     : void
    {
        $this->helper = new \ilResourceStorageMigrationHelper(
            new Stakeholder(),
            $environment
        );
        $this->root_user_id = $this->helper->getDatabase()->fetchObject(
            $this->helper->getDatabase()->query(
                'SELECT usr_id FROM usr_data WHERE login="root"'
            )
        )?->usr_id ?? 6;
    }

◆ step()

ILIAS\User\Setup\MigrateNewAccountAttachments::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 58 of file MigrateNewAccountAttachments.php.

                                                  : void
    {
        $db = $this->helper->getDatabase();
        $res = $db->fetchObject(
            $db->query(
                'SELECT
                    att_file, lang
                FROM mail_template
                WHERE att_file IS NOT NULL AND type = "nacc" LIMIT 1;'
            )
        );
 
        $path = '/' . implode(
            '/',
            array_map(
                static fn(string $path_part): string => trim($path_part, '/'),
                [
                    $this->helper->getClientDataDir() . '/ilReg/reg_7',
                    $res->lang,
                ]
            )
        );
 
        $rid = null;
 
        if (file_exists($path)) {
            $rid = $this->helper->movePathToStorage(
                $path,
                $this->root_user_id,
                static fn() => $res->att_file,
                static fn() => $res->att_file
            );
        }
        if ($rid !== null) {
            $rid = $rid->serialize();
        }
 
        $db->update(
            'mail_template',
            [
                'att_file' => [\ilDBConstants::T_TEXT, null],
                'att_rid' => [\ilDBConstants::T_TEXT, $rid]
            ],
            [
                'lang' => [\ilDBConstants::T_TEXT, $res->lang],
                'type' => [\ilDBConstants::T_TEXT, 'nacc'],
            ]
        );
    }