ilPollImagesMigration Class Reference

Inheritance diagram for ilPollImagesMigration:

Collaboration diagram for ilPollImagesMigration:

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...
	getImageFullPath (string $img, int $id)
	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...

Protected Member Functions
	getThumbnailImagePath (string $img, int $id)
	getOrgImagePath (string $img, int $id)
	getLegacyPath (int $a_id)
	logError (string $text)

Protected Attributes
ilDBInterface	$db
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.ilPollImagesMigration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilPollImagesMigration::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 36 of file class.ilPollImagesMigration.php.

                                                   : int
    {
        return 5;
    }

getImageFullPath()

ilPollImagesMigration::getImageFullPath	(	string	$img,
		int	$id
	)

Definition at line 119 of file class.ilPollImagesMigration.php.

                                                          : ?string
    {
        return $this->getLegacyPath($id) . '/' . $img;
    }

References $id.

getLabel()

ilPollImagesMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return "PollImagesMigration";
    }

getLegacyPath()

ilPollImagesMigration::getLegacyPath ( int  $a_id )

protected

Definition at line 134 of file class.ilPollImagesMigration.php.

                                               : string
    {
        $path = 'sec/ilPoll/' . ilFileSystemAbstractionStorage::createPathFromId($a_id, 'poll');
        return rtrim(CLIENT_WEB_DIR, '/') . '/' . rtrim($path, '/');
    }

References $path, CLIENT_WEB_DIR, and ilFileSystemAbstractionStorage\createPathFromId().

Here is the call graph for this function:

getOrgImagePath()

ilPollImagesMigration::getOrgImagePath ( string  $img, int  $id  )

protected

Definition at line 129 of file class.ilPollImagesMigration.php.

                                                            : string
    {
        return $this->getLegacyPath($id) . "/org_" . $img;
    }

References $id.

getPreconditions()

ilPollImagesMigration::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 41 of file class.ilPollImagesMigration.php.

     : array {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilDatabaseUpdatedObjective(),
        ];
    }

getRemainingAmountOfSteps()

ilPollImagesMigration::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 110 of file class.ilPollImagesMigration.php.

                                               : int
    {
        $res = $this->db->query(
            'SELECT COUNT(*) AS count FROM il_poll WHERE migrated = 0'
        );
        $row = $this->db->fetchAssoc($res);
        return (int) $row['count'];
    }

References $res.

getThumbnailImagePath()

ilPollImagesMigration::getThumbnailImagePath ( string  $img, int  $id  )

protected

Definition at line 124 of file class.ilPollImagesMigration.php.

                                                                  : string
    {
        return $this->getLegacyPath($id) . "/thb_" . $img;
    }

References $id.

logError()

ilPollImagesMigration::logError ( string  $text )

protected

Definition at line 140 of file class.ilPollImagesMigration.php.

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

References $text.

prepare()

ilPollImagesMigration::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 51 of file class.ilPollImagesMigration.php.

     : void {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        if ($io instanceof IOWrapper) {
            $this->io = $io;
        }
    }

step()

ilPollImagesMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 61 of file class.ilPollImagesMigration.php.

     : void {
        $res = $this->db->query("SELECT id, image FROM il_poll WHERE migrated = 0 LIMIT 1");
        $row = $res->fetchAssoc();
        $image = $row["image"] ?? "";
        $id = (int) $row["id"];
 
        if ($image === "") {
            $this->db->manipulate("UPDATE il_poll SET migrated = 1 WHERE id = " . $this->db->quote($id, ilDBConstants::T_INTEGER));
            return;
        }
 
        $file_path = $this->getImageFullPath($image, $id);
        $thumbnail_path = $this->getThumbnailImagePath($image, $id);
        $org_path = $this->getOrgImagePath($image, $id);
        $stakeholder = (new ilPollImageRepositoryStakeholder())->withUserId(6);
 
        $irss_helper = new ilResourceStorageMigrationHelper($stakeholder, $environment);
        $rid = $irss_helper->movePathToStorage($file_path, 6, null, null, false);
        $rid_thumbnail = $irss_helper->movePathToStorage($thumbnail_path, 6, null, null, false);
        $org_thumbnail = $irss_helper->movePathToStorage($org_path, 6, null, null, false);
 
        $res_existing = $this->db->query("SELECT * FROM il_poll_image WHERE object_id = " . $this->db->quote($id, ilDBConstants::T_INTEGER));
        $row_existing = $res_existing->fetchAssoc();
        if (!is_null($rid)) {
            if (is_null($row_existing)) {
                $this->db->manipulate(
                    "INSERT INTO il_poll_image (object_id, rid) VALUES "
                    . " (" . $this->db->quote($id, ilDBConstants::T_INTEGER)
                    . ", " . $this->db->quote($rid->serialize(), ilDBConstants::T_TEXT) . ")"
                );
            } else {
                $irss_helper->getResourceBuilder()->remove($irss_helper->getResourceBuilder()->get($rid), $stakeholder);
            }
        } else {
            $this->logError('Image ' . $file_path . ' of poll with object ID ' . $id . ' could not be moved to storage.');
        }
 
        if (!is_null($rid_thumbnail)) {
            $irss_helper->getResourceBuilder()->remove($irss_helper->getResourceBuilder()->get($rid_thumbnail), $stakeholder);
        }
        if (!is_null($org_thumbnail)) {
            $irss_helper->getResourceBuilder()->remove($irss_helper->getResourceBuilder()->get($org_thumbnail), $stakeholder);
        }
 
        $this->db->manipulate("UPDATE il_poll SET migrated = 1 WHERE id = " . $this->db->quote($id, ilDBConstants::T_INTEGER));
    }

References $id, and ilDBConstants\T_INTEGER.

Field Documentation

$db

ilDBInterface ilPollImagesMigration::$db

protected

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

$io

IOWrapper ilPollImagesMigration::$io = null

protected

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

---

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

• components/ILIAS/Poll/classes/Setup/class.ilPollImagesMigration.php