blob: 3083233a4c423f6a7058be1723fce828fae0777d (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
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 unique ID
*
* @since 24.0.0
*/
public function getId(): string;
/**
* Returns the display name
*
* @since 24.0.0
*/
public function getDisplayName(): string;
/**
* Returns the description
*
* @since 24.0.0
*/
public function getDescription(): string;
/**
* 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($this->getId()) to get the version from the archive
*
* @since 24.0.0
*/
public function canImport(
IImportSource $importSource
): bool;
}
|
