ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
Migration.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
21 namespace ILIAS\Setup;
22 
28 interface Migration
29 {
30  public const INFINITE = -1;
31 
35  public function getLabel(): string;
36 
41  public function getDefaultAmountOfStepsPerRun(): int;
42 
49  public function getPreconditions(Environment $environment): array;
50 
57  public function prepare(Environment $environment): void;
58 
62  public function step(Environment $environment): void;
63 
68  public function getRemainingAmountOfSteps(): int;
69 }
step(Environment $environment)
Run one step of the migration.
A migration is a potentially long lasting operation that can be broken into discrete steps...
Definition: Migration.php:28
prepare(Environment $environment)
Prepare the migration by means of some environment.
getDefaultAmountOfStepsPerRun()
Tell the default amount of steps to be executed for one run of the migration.
getRemainingAmountOfSteps()
Count up how many "things" need to be migrated.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
An environment holds resources to be used in the setup process.
Definition: Environment.php:27
getPreconditions(Environment $environment)
Objectives the migration depend on.