mirror of
https://github.com/nextcloud/server.git
synced 2024-08-16 14:12:54 +02:00
86 lines
2.5 KiB
PHP
86 lines
2.5 KiB
PHP
<?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.
|
|
* @param ?callable(\OCP\Files\Node):bool $nodeFilter Callback to filter nodes to copy
|
|
* @throws UserMigrationException
|
|
*
|
|
* @since 24.0.0
|
|
*/
|
|
public function copyFolder(Folder $folder, string $destinationPath, ?callable $nodeFilter = null): 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;
|
|
}
|