ilExerciseInstructionFilesMigration Class Reference

Inheritance diagram for ilExerciseInstructionFilesMigration:

Collaboration diagram for ilExerciseInstructionFilesMigration:

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

Protected Member Functions
	buildAbsolutPath (int $exec_id, int $assignment_id)

Protected Attributes
ilResourceStorageMigrationHelper	$helper

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

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Member Function Documentation

buildAbsolutPath()

ilExerciseInstructionFilesMigration::buildAbsolutPath ( int  $exec_id, int  $assignment_id  )

protected

Definition at line 108 of file class.ilExerciseInstructionFilesMigration.php.

References CLIENT_WEB_DIR, and ilFileSystemAbstractionStorage\createPathFromId().

                                                                         : string
    {
        return CLIENT_WEB_DIR
            . '/ilExercise/'
            . \ilFileSystemAbstractionStorage::createPathFromId(
                $exec_id,
                "exc"
            ) . "/ass_$assignment_id";
    }

Here is the call graph for this function:

getDefaultAmountOfStepsPerRun()

ilExerciseInstructionFilesMigration::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 40 of file class.ilExerciseInstructionFilesMigration.php.

                                                   : int
    {
        return 1000;
    }

getLabel()

ilExerciseInstructionFilesMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 35 of file class.ilExerciseInstructionFilesMigration.php.

                              : string
    {
        return "Migration of exercise instructions files to the resource storage service.";
    }

getPreconditions()

ilExerciseInstructionFilesMigration::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 45 of file class.ilExerciseInstructionFilesMigration.php.

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

getRemainingAmountOfSteps()

ilExerciseInstructionFilesMigration::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 98 of file class.ilExerciseInstructionFilesMigration.php.

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

                                               : int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT count(id) AS amount FROM exc_assignment JOIN object_data ON exc_id = obj_id WHERE if_rcid IS NULL OR if_rcid = ''"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);

        return (int)$d->amount;
    }

prepare()

ilExerciseInstructionFilesMigration::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 50 of file class.ilExerciseInstructionFilesMigration.php.

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

step()

ilExerciseInstructionFilesMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 58 of file class.ilExerciseInstructionFilesMigration.php.

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

                                                  : void
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT id, exc_id, owner FROM exc_assignment JOIN object_data ON exc_id = obj_id WHERE if_rcid IS NULL OR if_rcid = '' LIMIT 1;"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);
        if (!($d instanceof stdClass)) {
            return;
        }

        $exec_id = (int)$d->exc_id;
        $assignment_id = (int)$d->id;
        $resource_owner_id = (int)$d->owner;
        $base_path = $this->buildAbsolutPath($exec_id, $assignment_id);
        if (is_dir($base_path)) {
            $collection_id = $this->helper->moveFilesOfPathToCollection(
                $base_path,
                $resource_owner_id
            );
        } else {
            $collection = $this->helper->getCollectionBuilder()->new($resource_owner_id);
            if ($this->helper->getCollectionBuilder()->store($collection)) {
                $collection_id = $collection->getIdentification()->serialize();
            } else {
                throw new ilException("Could not build collection");
            }
        }

        $this->helper->getDatabase()->update(
            'exc_assignment',
            [
                'if_rcid' => ['text', $collection_id]
            ],
            [
                'id' => ['integer', $assignment_id],
                'exc_id' => ['integer', $exec_id]
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilExerciseInstructionFilesMigration::$helper

protected

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

---

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

• Modules/Exercise/classes/Setup/class.ilExerciseInstructionFilesMigration.php