ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Migration.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
21namespace ILIAS\Setup;
22
28interface Migration
29{
30 public const INFINITE = -1;
31
35 public function getLabel(): string;
36
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}
An environment holds resources to be used in the setup process.
Definition: Environment.php:28
A migration is a potentially long lasting operation that can be broken into discrete steps.
Definition: Migration.php:29
getRemainingAmountOfSteps()
Count up how many "things" need to be migrated.
step(Environment $environment)
Run one step of the migration.
getDefaultAmountOfStepsPerRun()
Tell the default amount of steps to be executed for one run of the migration.
prepare(Environment $environment)
Prepare the migration by means of some environment.
getPreconditions(Environment $environment)
Objectives the migration depend on.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...