upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-05-28 04:32:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 54

Adapt user_migration APIs to have information about failures

Browse source 
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
This commit is contained in:
Côme Chilliet 2022-04-12 16:02:29 +02:00 committed by Vincent Petry
parent cd95fce105
commit a77ffe8593
No known key found for this signature in database
GPG key ID: E055D6A4D513575C
2 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lib/public/UserMigration/IExportDestination.php
View file

@ -38,36 +38,37 @@ interface IExportDestination {
*
* @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.
* @return bool whether the file contents were successfully added.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function addFileContents(string $path, string $content): bool;
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.
* @return bool whether the file stream was successfully added.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function addFileAsStream(string $path, $stream): bool;
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.
* @return bool whether the folder was successfully added.
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function copyFolder(Folder $folder, string $destinationPath): bool;
public function copyFolder(Folder $folder, string $destinationPath): void;
/**
* @param array<string,int> $versions Migrators and their versions.
* @throws UserMigrationException
*
* @since 24.0.0
*/
@ -76,6 +77,8 @@ interface IExportDestination {
/**
* Called after export is complete
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function close(): void;

16
lib/public/UserMigration/IImportSource.php
View file

@ -39,6 +39,7 @@ interface IImportSource {
*
* @param string $path Full path to the file in the export archive.
* @return string The full content of the file.
* @throws UserMigrationException
*
* @since 24.0.0
*/
@ -49,6 +50,7 @@ interface IImportSource {
*
* @param string $path Full path to the file in the export archive.
* @return resource A stream resource to read from to get the file content.
* @throws UserMigrationException
*
* @since 24.0.0
*/
@ -59,6 +61,7 @@ interface IImportSource {
*
* @param string $path Full path to the folder in the export archive.
* @return array The list of files.
* @throws UserMigrationException
*
* @since 24.0.0
*/
@ -67,6 +70,8 @@ interface IImportSource {
/**
* Test if a path exists, which may be a file or a folder
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function pathExists(string $path): bool;
@ -77,12 +82,15 @@ interface IImportSource {
* Folder $destination folder to copy into
* string $sourcePath path in the export archive
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function copyToFolder(Folder $destination, string $sourcePath): bool;
public function copyToFolder(Folder $destination, string $sourcePath): void;
/**
* @return array<string,int> Migrators and their versions from the export archive.
* @throws UserMigrationException
*
* @since 24.0.0
*/
@ -90,7 +98,7 @@ interface IImportSource {
/**
* @return ?int Version for this migrator from the export archive. Null means migrator missing.
*
* @throws UserMigrationException
* @param string $migrator Migrator id (as returned by IMigrator::getId)
*
* @since 24.0.0
@ -100,6 +108,8 @@ interface IImportSource {
/**
* Get original uid of the imported account
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function getOriginalUid(): string;
@ -107,6 +117,8 @@ interface IImportSource {
/**
* Called after import is complete
*
* @throws UserMigrationException
*
* @since 24.0.0
*/
public function close(): void;