ilForumPostingFilesMigration Class Reference

Inheritance diagram for ilForumPostingFilesMigration:

Collaboration diagram for ilForumPostingFilesMigration:

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 ()

Protected Member Functions
	buildBasePath ()

Protected Attributes
ilResourceStorageMigrationHelper	$helper

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

Detailed Description

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

Member Function Documentation

buildBasePath()

ilForumPostingFilesMigration::buildBasePath ( )

protected

Definition at line 117 of file class.ilForumPostingFilesMigration.php.

References CLIENT_DATA_DIR.

                                      : string
    {
        return CLIENT_DATA_DIR . '/forum/';
    }

getDefaultAmountOfStepsPerRun()

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

                                                   : int
    {
        return 10000;
    }

getFileNameCallback()

ilForumPostingFilesMigration::getFileNameCallback

(

string

$pattern

)

Definition at line 122 of file class.ilForumPostingFilesMigration.php.

Referenced by step().

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

Here is the caller graph for this function:

getLabel()

ilForumPostingFilesMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return 'Migration of Files in Forum Posts to the Resource Storage Service.';
    }

getPreconditions()

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

References ilResourceStorageMigrationHelper\getPreconditions().

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

Here is the call graph for this function:

getRemainingAmountOfSteps()

ilForumPostingFilesMigration::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 103 of file class.ilForumPostingFilesMigration.php.

References Vendor\Package\$d, and $r.

                                               : int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
    count(frm_posts.pos_pk) AS amount
FROM frm_posts
JOIN frm_data ON frm_posts.pos_top_fk = frm_data.top_pk
WHERE frm_posts.rcid IS NULL OR frm_posts.rcid = '';"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);

        return (int) $d->amount;
    }

getRevisionNameCallback()

ilForumPostingFilesMigration::getRevisionNameCallback

(

)

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

Referenced by step().

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

Here is the caller graph for this function:

prepare()

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

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

step()

ilForumPostingFilesMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

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

References Vendor\Package\$d, $r, getFileNameCallback(), getRevisionNameCallback(), and ILIAS\Repository\int().

                                                  : void
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
    frm_posts.pos_pk AS posting_id,
    frm_posts.pos_author_id AS owner_id,
    frm_data.top_frm_fk AS object_id
FROM frm_posts
JOIN frm_data ON frm_posts.pos_top_fk = frm_data.top_pk
WHERE frm_posts.rcid IS NULL OR frm_posts.rcid = ''
LIMIT 1;"
        );

        $d = $this->helper->getDatabase()->fetchObject($r);
        if (!($d instanceof stdClass)) {
            return;
        }

        $posting_id = (int) $d->posting_id;
        $object_id = (int) $d->object_id;
        $resource_owner_id = (int) $d->owner_id;

        $base_path = $this->buildBasePath();
        $filename_pattern = '/^' . $object_id . '\_' . $posting_id . '\_(.*)/m';
        $pattern = '/.*\/' . $object_id . '\_' . $posting_id . '\_(.*)/m';

        if (is_dir($base_path) && count(scandir($base_path)) > 2) {
            $collection_id = $this->helper->moveFilesOfPatternToCollection(
                $base_path,
                $pattern,
                $resource_owner_id,
                ResourceCollection::NO_SPECIFIC_OWNER,
                $this->getFileNameCallback($filename_pattern),
                $this->getRevisionNameCallback()
            );

            $save_colletion_id = $collection_id === null ? '-' : $collection_id->serialize();
            $this->helper->getDatabase()->update(
                'frm_posts',
                ['rcid' => ['text', $save_colletion_id]],
                ['pos_pk' => ['integer', $posting_id],]
            );
        } else {
            $this->helper->getDatabase()->update(
                'frm_posts',
                ['rcid' => ['text', '-']],
                ['pos_pk' => ['integer', $posting_id],]
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilForumPostingFilesMigration::$helper

protected

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

---

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

• Modules/Forum/classes/Setup/Migrations/class.ilForumPostingFilesMigration.php