aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/ITempManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/ITempManager.php')
-rw-r--r--lib/public/ITempManager.php53
1 files changed, 53 insertions, 0 deletions
diff --git a/lib/public/ITempManager.php b/lib/public/ITempManager.php
new file mode 100644
index 00000000000..ac8f829f357
--- /dev/null
+++ b/lib/public/ITempManager.php
@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP;
+
+/**
+ * Interface ITempManager
+ *
+ * @since 8.0.0
+ */
+interface ITempManager {
+ /**
+ * Create a temporary file and return the path
+ *
+ * @param string $postFix Postfix appended to the temporary file name
+ *
+ * @since 8.0.0
+ */
+ public function getTemporaryFile(string $postFix = ''): string|false;
+
+ /**
+ * Create a temporary folder and return the path
+ *
+ * @param string $postFix Postfix appended to the temporary folder name
+ *
+ * @since 8.0.0
+ */
+ public function getTemporaryFolder(string $postFix = ''): string|false;
+
+ /**
+ * Remove the temporary files and folders generated during this request
+ * @since 8.0.0
+ */
+ public function clean();
+
+ /**
+ * Remove old temporary files and folders that were failed to be cleaned
+ * @since 8.0.0
+ */
+ public function cleanOld();
+
+ /**
+ * Get the temporary base directory
+ *
+ * @return string
+ * @since 8.2.0
+ */
+ public function getTempBaseDir();
+}