ILIAS\Setup\Migration Interface Reference

A migration is a potentially long lasting operation that can be broken into discrete steps. More...

Inheritance diagram for ILIAS\Setup\Migration:

Collaboration diagram for ILIAS\Setup\Migration:

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

Data Fields
const	INFINITE = -1

Detailed Description

A migration is a potentially long lasting operation that can be broken into discrete steps.

Other than database updates, it is supposed to run in the background, even when the installation is online again.

Definition at line 28 of file Migration.php.

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ILIAS\Setup\Migration::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.

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration, ilDataCollectionStorageMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ilMobMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, and ILIAS\User\Setup\UserProfileMigrations.

getLabel()

ILIAS\Setup\Migration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ILIAS\Blog\Setup\InitLOMForBlogMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration, ilDataCollectionInitLOMMigration, ilDataCollectionStorageMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilGlossaryDeleteLOMOfDefinitionsMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ILIAS\MediaCast\Setup\InitLOMForMediaCastMigration, ilMobMigration, ILIAS\MediaPool\Setup\InitLOMForMediaPoolMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, ILIAS\User\Setup\UserProfileMigrations, and ILIAS\Wiki\Setup\InitLOMForWikiMigration.

getPreconditions()

ILIAS\Setup\Migration::getPreconditions

(

Environment

$environment

)

Objectives the migration depend on.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ilMobMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, and ILIAS\User\Setup\UserProfileMigrations.

getRemainingAmountOfSteps()

ILIAS\Setup\Migration::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

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration, ilDataCollectionStorageMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ilMobMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, and ILIAS\User\Setup\UserProfileMigrations.

prepare()

ILIAS\Setup\Migration::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.

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ilMobMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, and ILIAS\User\Setup\UserProfileMigrations.

step()

ILIAS\Setup\Migration::step

(

Environment

$environment

)

Run one step of the migration.

Implemented in ILIAS\AdvancedMetaData\Setup\RecordFilesMigration, ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration, ilBadgesFilesMigration, ilBadgeTemplatesFilesMigration, ilBookingManagerBookingInfoMigration, ilBookingManagerObjectInfoMigration, ILIAS\Setup\ilMysqlMyIsamToInnoDbMigration, ilExerciseInstructionFilesMigration, ilExercisePeerFeedbackMigration, ilExerciseSampleSolutionMigration, ilExerciseSubmissionMigration, ilExerciseTutorFeedbackFileMigration, ilExerciseTutorTeamFeedbackFileMigration, ilExportFilesToIRSSMigration, ilHTLMMigration, ILIAS\ILIASObject\Setup\MigrateTranslations, ilMobMigration, ILIAS\MetaData\Setup\DeleteLOMForObjectTypeMigration, ILIAS\MetaData\Setup\InitLOMForObjectTypeMigration, ilPollImagesMigration, ilStyleIRSSMigration, ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration, ilTestQuestionPoolFileUploadQuestionMigration, ILIAS\User\Setup\MigrateNewAccountAttachments, and ILIAS\User\Setup\UserProfileMigrations.

Field Documentation

INFINITE

const ILIAS\Setup\Migration::INFINITE = -1

Definition at line 30 of file Migration.php.

Referenced by ILIAS\Setup\CLI\MigrateCommand\configure(), ILIAS\AdvancedMetaData\Setup\SelectOptionsMigration\getDefaultAmountOfStepsPerRun(), and ILIAS\Setup\CLI\MigrateCommand\runMigration().

---

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

• components/ILIAS/Setup/src/Migration.php