aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/UserMigration/ISizeEstimationMigrator.php
blob: 2d1f3466f2cf3c9f4c82a1566f1f06538e5fab66 (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
<?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;
}