ISizeEstimationMigrator.php 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2022 Christopher Ng <chrng8@gmail.com>
  5. *
  6. * @author Christopher Ng <chrng8@gmail.com>
  7. * @author Côme Chilliet <come.chilliet@nextcloud.com>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\UserMigration;
  26. use OCP\IUser;
  27. /**
  28. * @since 25.0.0
  29. */
  30. interface ISizeEstimationMigrator {
  31. /**
  32. * Returns an estimate of the exported data size in KiB.
  33. * Should be fast, favor performance over accuracy.
  34. *
  35. * @since 25.0.0
  36. * @since 27.0.0 return value may overflow from int to float
  37. */
  38. public function getEstimatedExportSize(IUser $user): int|float;
  39. }