aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/UserMigration/ISizeEstimationMigrator.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/UserMigration/ISizeEstimationMigrator.php')
-rw-r--r--lib/public/UserMigration/ISizeEstimationMigrator.php26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/public/UserMigration/ISizeEstimationMigrator.php b/lib/public/UserMigration/ISizeEstimationMigrator.php
new file mode 100644
index 00000000000..2d1f3466f2c
--- /dev/null
+++ b/lib/public/UserMigration/ISizeEstimationMigrator.php
@@ -0,0 +1,26 @@
+<?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;
+
+/**
+ * @since 25.0.0
+ */
+interface ISizeEstimationMigrator {
+ /**
+ * Returns an estimate of the exported data size in KiB.
+ * Should be fast, favor performance over accuracy.
+ *
+ * @since 25.0.0
+ * @since 27.0.0 return value may overflow from int to float
+ */
+ public function getEstimatedExportSize(IUser $user): int|float;
+}