ILIAS  release_7 Revision v7.30-3-g800a261c036
Migration.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
5namespace ILIAS\Setup;
6
12interface Migration
13{
14 public const INFINITE = -1;
15
19 public function getLabel() : string;
20
27 public function getDefaultAmountOfStepsPerRun() : int;
28
35 public function getPreconditions(Environment $environment) : array;
36
43 public function prepare(Environment $environment) : void;
44
48 public function step(Environment $environment) : void;
49
56 public function getRemainingAmountOfSteps() : int;
57}
An exception for terminatinating execution or to throw for unit testing.
An environment holds resources to be used in the setup process.
Definition: Environment.php:12
A migration is a potentially long lasting operation that can be broken into discrete steps.
Definition: Migration.php:13
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...