IExportDestination.php 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
  5. *
  6. * @author Côme Chilliet <come.chilliet@nextcloud.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\UserMigration;
  25. use OCP\Files\Folder;
  26. /**
  27. * @since 24.0.0
  28. */
  29. interface IExportDestination {
  30. /**
  31. * Adds a file to the export
  32. *
  33. * @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
  34. * @param string $content The full content of the file.
  35. * @throws UserMigrationException
  36. *
  37. * @since 24.0.0
  38. */
  39. public function addFileContents(string $path, string $content): void;
  40. /**
  41. * Adds a file to the export as a stream
  42. *
  43. * @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
  44. * @param resource $stream A stream resource to read from to get the file content.
  45. * @throws UserMigrationException
  46. *
  47. * @since 24.0.0
  48. */
  49. public function addFileAsStream(string $path, $stream): void;
  50. /**
  51. * Copy a folder to the export
  52. *
  53. * @param Folder $folder folder to copy to the export archive.
  54. * @param string $destinationPath Full path to the folder in the export archive. Parent directories will be created if needed.
  55. * @param ?callable(\OCP\Files\Node):bool $nodeFilter Callback to filter nodes to copy
  56. * @throws UserMigrationException
  57. *
  58. * @since 24.0.0
  59. */
  60. public function copyFolder(Folder $folder, string $destinationPath, ?callable $nodeFilter = null): void;
  61. /**
  62. * @param array<string,int> $versions Migrators and their versions.
  63. * @throws UserMigrationException
  64. *
  65. * @since 24.0.0
  66. */
  67. public function setMigratorVersions(array $versions): void;
  68. /**
  69. * Called after export is complete
  70. *
  71. * @throws UserMigrationException
  72. *
  73. * @since 24.0.0
  74. */
  75. public function close(): void;
  76. }