Inheritance diagram for ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration:

Collaboration diagram for ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration:

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

Private Member Functions
	copyImageToThumb (int $object_id, int $question_id, string $image_file_name)

	updateThumbSize (int $question_id, int $question_type_id, int $image_width)

Private Attributes
ilDBInterface	$db

AdminInteraction	$io

string	$webdir

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

Detailed Description

Definition at line 27 of file RebuildMissingThumbnailMigration.php.

Member Function Documentation

◆ copyImageToThumb()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::copyImageToThumb	(	int	$object_id,
		int	$question_id,
		string	$image_file_name
	)

private

Definition at line 111 of file RebuildMissingThumbnailMigration.php.

Referenced by ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration\step().

      : ?int {
         $filepath = "{$this->webdir}/assessment/{$object_id}/{$question_id}/images/{$image_file_name}";
         $thumbpath = "{$this->webdir}/assessment/{$object_id}/{$question_id}/images/thumb.{$image_file_name}";
         if (!file_exists($filepath)
             || filesize($filepath) <= 0
             || !($image_info = getimagesize($filepath))
             || !is_writable(dirname($thumbpath))) {
             $this->io->inform("\nWARNING: Could not create thumbnail for image {$filepath} of question {$question_id}");
             return 0;
         }
 
         copy($filepath, $thumbpath);
         return $image_info[0];
     }

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::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 38 of file RebuildMissingThumbnailMigration.php.

                                                    : int
     {
         return 100;
     }

◆ getLabel()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 33 of file RebuildMissingThumbnailMigration.php.

                               : string
     {
         return 'Rebuild Missing Thumbnail Images';
     }

◆ getPreconditions()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::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 43 of file RebuildMissingThumbnailMigration.php.

                                                               : array
     {
         return [
             new \ilDatabaseInitializedObjective()
         ];
     }

◆ getRemainingAmountOfSteps()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::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 90 of file RebuildMissingThumbnailMigration.php.

                                                : int
     {
         $result = $this->db->query(
             'SELECT COUNT(*) cnt FROM' . PHP_EOL
             . '(SELECT q.question_id' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_sc s on q.question_id = s.question_fi JOIN qpl_a_sc sa on q.question_id = sa.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 1 AND s.thumb_size IS NULL AND NOT q.obj_fi = 0 and not sa.imagefile = "" AND NOT ISNULL(sa.imagefile)' . PHP_EOL
             . 'UNION' . PHP_EOL
             . 'SELECT q.question_id' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_mc m on q.question_id = m.question_fi JOIN qpl_a_mc ma on q.question_id = ma.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 2 AND m.thumb_size IS NULL AND NOT q.obj_fi = 0 AND NOT ma.imagefile = "" AND NOT ISNULL(ma.imagefile)' . PHP_EOL
             . 'UNION' . PHP_EOL
             . 'SELECT q.question_id' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_kprim k on q.question_id = k.question_fi JOIN qpl_a_kprim ka on q.question_id = ka.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 17 AND k.thumb_size IS NULL AND NOT q.obj_fi = 0 AND NOT ka.imagefile = "" AND NOT ISNULL(ka.imagefile)) cnt'
         );
         $row = $this->db->fetchAssoc($result);
 
         return (int) ($row['cnt'] ?? 0);
     }

◆ prepare()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::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 RebuildMissingThumbnailMigration.php.

References ILIAS\$ini, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, ILIAS\Setup\Environment\RESOURCE_DATABASE, and ILIAS\Setup\Environment\RESOURCE_ILIAS_INI.

                                                      : void
     {
         $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
         $this->io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
 
         $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
         $this->webdir = "{$ini->readVariable('server', 'absolute_path')}/{$ini->readVariable('clients', 'path')}/{$ini->readVariable('clients', 'default')}";
     }

Here is the call graph for this function:

◆ step()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 59 of file RebuildMissingThumbnailMigration.php.

References ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration\copyImageToThumb(), and ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration\updateThumbSize().

                                                   : void
     {
         $result = $this->db->query(
             '(SELECT sa.imagefile, q.obj_fi, q.question_type_fi, q.question_id' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_sc s on q.question_id = s.question_fi JOIN qpl_a_sc sa on q.question_id = sa.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 1 AND s.thumb_size IS NULL AND NOT q.obj_fi = 0 and not sa.imagefile = "" AND NOT ISNULL(sa.imagefile) ORDER BY q.question_id)' . PHP_EOL
             . 'UNION' . PHP_EOL
             . '(SELECT ma.imagefile, q.obj_fi, q.question_type_fi, q.question_id ' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_mc m on q.question_id = m.question_fi JOIN qpl_a_mc ma on q.question_id = ma.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 2 AND m.thumb_size IS NULL AND NOT q.obj_fi = 0 AND NOT ma.imagefile = "" AND NOT ISNULL(ma.imagefile) ORDER BY q.question_id)' . PHP_EOL
             . 'UNION' . PHP_EOL
             . '(SELECT ka.imagefile, q.obj_fi, q.question_type_fi, q.question_id' . PHP_EOL
             . 'FROM qpl_questions q JOIN qpl_qst_kprim k on q.question_id = k.question_fi JOIN qpl_a_kprim ka on q.question_id = ka.question_fi' . PHP_EOL
             . 'WHERE q.question_type_fi = 17 AND k.thumb_size IS NULL AND NOT q.obj_fi = 0 AND NOT ka.imagefile = "" AND NOT ISNULL(ka.imagefile) ORDER BY q.question_id)'
         );
 
         $previous_question_id = null;
         while (($row = $this->db->fetchObject($result)) !== null) {
             if ($previous_question_id !== null && $previous_question_id !== $row->question_id) {
                 $this->updateThumbSize($row->question_id, $row->question_type_fi, $image_width);
             }
             $image_width = $this->copyImageToThumb($row->obj_fi, $row->question_id, $row->imagefile);
             $previous_question_id = $row->question_id;
             $previous_question_type_id = $row->question_type_fi;
         }
 
         if (isset($previous_question_type_id)) {
             $this->updateThumbSize($previous_question_id, $previous_question_type_id, $image_width);
         }
     }

Here is the call graph for this function:

◆ updateThumbSize()

ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::updateThumbSize	(	int	$question_id,
		int	$question_type_id,
		int	$image_width
	)

private

Definition at line 130 of file RebuildMissingThumbnailMigration.php.

Referenced by ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration\step().

      : void {
         $this->db->replace(
             match ($question_type_id) {
                 1 => 'qpl_qst_sc',
                 2 => 'qpl_qst_mc',
                 17 => 'qpl_qst_kprim'
             },
             [
                 'thumb_size' => ['integer', $image_width],
             ],
             [
                 'question_fi' => ['integer', $question_id]
             ]
         );
     }

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::$db

private

Definition at line 29 of file RebuildMissingThumbnailMigration.php.

◆ $io

AdminInteraction ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::$io

private

Definition at line 30 of file RebuildMissingThumbnailMigration.php.

◆ $webdir

string ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration::$webdir

private

Definition at line 31 of file RebuildMissingThumbnailMigration.php.

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

Modules/TestQuestionPool/classes/Setup/RebuildMissingThumbnailMigration.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyImageToThumb()

◆ getDefaultAmountOfStepsPerRun()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ prepare()

◆ step()

◆ updateThumbSize()

Field Documentation

◆ $db

◆ $io

◆ $webdir