ilTestQuestionPoolFileUploadQuestionMigration Class Reference

Inheritance diagram for ilTestQuestionPoolFileUploadQuestionMigration:

Collaboration diagram for ilTestQuestionPoolFileUploadQuestionMigration:

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 $test_id, int $active_id, int $question_id, string $filename)

Private Attributes
ilResourceStorageMigrationHelper	$helper = null

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

Detailed Description

Definition at line 22 of file class.ilTestQuestionPoolFileUploadQuestionMigration.php.

Member Function Documentation

buildAbsolutPath()

ilTestQuestionPoolFileUploadQuestionMigration::buildAbsolutPath ( int  $test_id, int  $active_id, int  $question_id, string  $filename  )

protected

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

References $filename, and CLIENT_WEB_DIR.

Referenced by step().

     : string {
        return CLIENT_WEB_DIR
            . '/assessment'
            . '/tst_' . $test_id
            . '/' . $active_id
            . '/' . $question_id
            . '/files/'
            . $filename;
    }

Here is the caller graph for this function:

getDefaultAmountOfStepsPerRun()

ilTestQuestionPoolFileUploadQuestionMigration::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 31 of file class.ilTestQuestionPoolFileUploadQuestionMigration.php.

                                                   : int
    {
        return 1000;
    }

getLabel()

ilTestQuestionPoolFileUploadQuestionMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return 'File Upload Question Migration';
    }

getPreconditions()

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

References ilResourceStorageMigrationHelper\getPreconditions().

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

Here is the call graph for this function:

getRemainingAmountOfSteps()

ilTestQuestionPoolFileUploadQuestionMigration::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 115 of file class.ilTestQuestionPoolFileUploadQuestionMigration.php.

References $res.

                                               : int
    {
        $database = $this->helper->getDatabase();
        $res = $database->query(
            "SELECT COUNT(*) as count
            FROM tst_solutions
            INNER JOIN qpl_qst_fileupload ON qpl_qst_fileupload.question_fi = tst_solutions.question_fi
            INNER JOIN tst_active ON tst_active.active_id =  tst_solutions.active_fi
            WHERE tst_solutions.value2 != 'rid';"
        );

        return (int) $database->fetchAssoc($res)['count'];
    }

prepare()

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

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

step()

ilTestQuestionPoolFileUploadQuestionMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 49 of file class.ilTestQuestionPoolFileUploadQuestionMigration.php.

References $filename, $path, $res, $user_id, buildAbsolutPath(), ILIAS\Repository\int(), and null.

                                                  : void
    {
        $db = $this->helper->getDatabase();
        $res = $db->query(
            'SELECT
                tst_solutions.solution_id AS solution_id,
                tst_active.user_fi AS user_id,
                tst_solutions.question_fi AS question_id,
                tst_solutions.active_fi AS active_id,
                tst_active.test_fi AS test_id,
                tst_solutions.value1 AS filename,
                tst_solutions.value2 AS revision_name
            FROM tst_solutions
                     INNER JOIN qpl_qst_fileupload ON qpl_qst_fileupload.question_fi = tst_solutions.question_fi
                     INNER JOIN tst_active ON tst_active.active_id =  tst_solutions.active_fi
            WHERE tst_solutions.value2 != "rid";'
        );

        $res = $db->fetchAssoc($res);

        // read common data for all files of this question id
        $user_id = (int) $res['user_id'];
        $active_id = (int) $res['active_id'];
        $test_id = (int) $res['test_id'];
        $question_id = (int) $res['question_id'];
        $filename = $res['filename'];
        $revision_name = $res['revision_name'];
        $solution_id = (int) $res['solution_id'];

        // build path to file
        $path = $this->buildAbsolutPath(
            $test_id,
            $active_id,
            $question_id,
            $filename
        );

        $rid = null;

        if (file_exists($path)) {
            $rid = $this->helper->movePathToStorage(
                $path,
                $user_id,
                null,
                static function () use ($revision_name): string {
                    return $revision_name;
                }
            );
        }
        if ($rid !== null) {
            $rid = $rid->serialize(); // no files found
        }

        // store the rid in as value1 and 'rid' as value2
        $db->update(
            'tst_solutions',
            [
                'value1' => ['string', $rid],
                'value2' => ['string', 'rid']
            ],
            [
                'solution_id' => ['integer', $solution_id]
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

$helper

ilResourceStorageMigrationHelper ilTestQuestionPoolFileUploadQuestionMigration::$helper = null

private

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

---

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

• components/ILIAS/TestQuestionPool/classes/Setup/Migration/class.ilTestQuestionPoolFileUploadQuestionMigration.php