aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Migration/IOutput.php
blob: 60e870055fea3fad45eb3bb1ac14338360e0b99d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\Migration;

/**
 * Interface IOutput
 *
 * @since 9.1.0
 */
interface IOutput {
	/**
	 * @param string $message
	 * @return void
	 * @since 28.0.0
	 */
	public function debug(string $message): void;

	/**
	 * @param string $message
	 * @return void
	 * @since 9.1.0
	 */
	public function info($message);

	/**
	 * @param string $message
	 * @return void
	 * @since 9.1.0
	 */
	public function warning($message);

	/**
	 * @param int $max
	 * @return void
	 * @since 9.1.0
	 */
	public function startProgress($max = 0);

	/**
	 * @param int $step
	 * @param string $description
	 * @return void
	 * @since 9.1.0
	 */
	public function advance($step = 1, $description = '');

	/**
	 * @return void
	 * @since 9.1.0
	 */
	public function finishProgress();
}