ITempManager.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. * @package OCP
  29. * @since 8.0.0
  30. */
  31. interface ITempManager {
  32. /**
  33. * Create a temporary file and return the path
  34. *
  35. * @param string $postFix
  36. * @return string
  37. * @since 8.0.0
  38. */
  39. public function getTemporaryFile($postFix = '');
  40. /**
  41. * Create a temporary folder and return the path
  42. *
  43. * @param string $postFix
  44. * @return string
  45. * @since 8.0.0
  46. */
  47. public function getTemporaryFolder($postFix = '');
  48. /**
  49. * Remove the temporary files and folders generated during this request
  50. * @since 8.0.0
  51. */
  52. public function clean();
  53. /**
  54. * Remove old temporary files and folders that were failed to be cleaned
  55. * @since 8.0.0
  56. */
  57. public function cleanOld();
  58. /**
  59. * Get the temporary base directory
  60. *
  61. * @return string
  62. * @since 8.2.0
  63. */
  64. public function getTempBaseDir();
  65. }