ilExerciseSubmissionMigration Class Reference

Inheritance diagram for ilExerciseSubmissionMigration:

Collaboration diagram for ilExerciseSubmissionMigration:

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, int $user_id)

Protected Attributes
ilResourceStorageMigrationHelper	$helper

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

Detailed Description

Definition at line 24 of file class.ilExerciseSubmissionMigration.php.

Member Function Documentation

buildAbsolutPath()

ilExerciseSubmissionMigration::buildAbsolutPath ( int  $exec_id, int  $assignment_id, int  $user_id  )

protected

Definition at line 97 of file class.ilExerciseSubmissionMigration.php.

References $user_id, CLIENT_DATA_DIR, and ilFileSystemAbstractionStorage\createPathFromId().

Referenced by step().

                                                                                       : string
    {
        // ilExercise/X/exc_*EXC_ID*/subm_*ASS_ID*/*USER_ID*/*TIMESTAMP*_filename.pdf
        return CLIENT_DATA_DIR
            . '/ilExercise/'
            . \ilFileSystemAbstractionStorage::createPathFromId(
                $exec_id,
                "exc"
            ) . "/subm_$assignment_id/" . $user_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultAmountOfStepsPerRun()

ilExerciseSubmissionMigration::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 33 of file class.ilExerciseSubmissionMigration.php.

                                                   : int
    {
        return 1000;
    }

getLabel()

ilExerciseSubmissionMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

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

getPreconditions()

ilExerciseSubmissionMigration::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 38 of file class.ilExerciseSubmissionMigration.php.

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

getRemainingAmountOfSteps()

ilExerciseSubmissionMigration::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 87 of file class.ilExerciseSubmissionMigration.php.

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

                                               : int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT count(er.returned_id) as amount FROM exc_returned er JOIN object_data od ON er.obj_id = od.obj_id WHERE er.rid IS NULL;"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);

        return (int) $d->amount;
    }

prepare()

ilExerciseSubmissionMigration::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 43 of file class.ilExerciseSubmissionMigration.php.

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

step()

ilExerciseSubmissionMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 51 of file class.ilExerciseSubmissionMigration.php.

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

                                                  : void
    {
        $db = $this->helper->getDatabase();
        $r = $db->query(
            "SELECT er.returned_id, er.obj_id, er.ass_id, od.owner, er.user_id, er.team_id FROM exc_returned er JOIN object_data od ON er.obj_id = od.obj_id WHERE er.rid IS NULL LIMIT 1;"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);
        $exec_id = (int) $d->obj_id;
        $assignment_id = (int) $d->ass_id;
        $returned_id = (int) $d->returned_id;
        $resource_owner_id = (int) $d->owner;
        $user_id = ((int) $d->team_id) > 0
            ? (int) $d->team_id
            : (int) $d->user_id;
        $base_path = $this->buildAbsolutPath($exec_id, $assignment_id, $user_id);
        $pattern = '/[^\.].*/m';
        $rid = "";
        if (is_dir($base_path)) {
            $rid = $this->helper->moveFirstFileOfPatternToStorage(
                $base_path,
                $pattern,
                $resource_owner_id
            );
        }
        $this->helper->getDatabase()->update(
            'exc_returned',
            [
                'rid' => ['text', (string) $rid]
            ],
            [
                'ass_id' => ['integer', $assignment_id],
                'returned_id' => ['integer', $returned_id]
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilExerciseSubmissionMigration::$helper

protected

Definition at line 26 of file class.ilExerciseSubmissionMigration.php.

---

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

• components/ILIAS/Exercise/classes/Setup/class.ilExerciseSubmissionMigration.php