blob: 65d228faeb9316a9b54b83dca2624dba5f338f78 (
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\UserMigration;
use OCP\Files\Folder;
/**
* @since 24.0.0
*/
interface IExportDestination {
/**
* Adds a file to the export
*
* @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
* @param string $content The full content of the file.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function addFileContents(string $path, string $content): void;
/**
* Adds a file to the export as a stream
*
* @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
* @param resource $stream A stream resource to read from to get the file content.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function addFileAsStream(string $path, $stream): void;
/**
* Copy a folder to the export
*
* @param Folder $folder folder to copy to the export archive.
* @param string $destinationPath Full path to the folder in the export archive. Parent directories will be created if needed.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function copyFolder(Folder $folder, string $destinationPath): void;
/**
* @param array<string,int> $versions Migrators and their versions.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function setMigratorVersions(array $versions): void;
/**
* Called after export is complete
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function close(): void;
}
|
