ITempManager.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Morris Jobke <hey@morrisjobke.de>
  6. * @author Robin Appelman <robin@icewind.nl>
  7. * @author Robin McCorkell <robin@mccorkell.me.uk>
  8. *
  9. * @license AGPL-3.0
  10. *
  11. * This code is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License, version 3,
  13. * as published by the Free Software Foundation.
  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, version 3,
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>
  22. *
  23. */
  24. namespace OCP;
  25. /**
  26. * Interface ITempManager
  27. *
  28. * @since 8.0.0
  29. */
  30. interface ITempManager {
  31. /**
  32. * Create a temporary file and return the path
  33. *
  34. * @param string $postFix
  35. * @return string
  36. * @since 8.0.0
  37. */
  38. public function getTemporaryFile($postFix = '');
  39. /**
  40. * Create a temporary folder and return the path
  41. *
  42. * @param string $postFix
  43. * @return string
  44. * @since 8.0.0
  45. */
  46. public function getTemporaryFolder($postFix = '');
  47. /**
  48. * Remove the temporary files and folders generated during this request
  49. * @since 8.0.0
  50. */
  51. public function clean();
  52. /**
  53. * Remove old temporary files and folders that were failed to be cleaned
  54. * @since 8.0.0
  55. */
  56. public function cleanOld();
  57. /**
  58. * Get the temporary base directory
  59. *
  60. * @return string
  61. * @since 8.2.0
  62. */
  63. public function getTempBaseDir();
  64. }