blob: c97fb3c0bcad93852f29049b2d890a3642af3338 (
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
|
<?php
declare(strict_types=1);
/**
* @copyright 2022 Christopher Ng <chrng8@gmail.com>
*
* @author Christopher Ng <chrng8@gmail.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\IUser;
use Symfony\Component\Console\Output\OutputInterface;
/**
* @since 24.0.0
*/
interface IMigrator {
/**
* Export user data
*
* @throws UserMigrationException
* @since 24.0.0
*/
public function export(
IUser $user,
IExportDestination $exportDestination,
OutputInterface $output
): void;
/**
* Import user data
*
* @throws UserMigrationException
* @since 24.0.0
*/
public function import(
IUser $user,
IImportSource $importSource,
OutputInterface $output
): void;
/**
* Returns the version of the export format for this migrator
*
* @since 24.0.0
*/
public function getVersion(): int;
/**
* Checks whether it is able to import a version of the export format for this migrator
* Use $importSource->getMigratorVersion(static::class) to get the version from the archive
*
* @since 24.0.0
*/
public function canImport(
IImportSource $importSource
): bool;
}
|
