aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Share_Backend_File_Dependent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Share_Backend_File_Dependent.php')
-rw-r--r--lib/public/Share_Backend_File_Dependent.php27
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/public/Share_Backend_File_Dependent.php b/lib/public/Share_Backend_File_Dependent.php
new file mode 100644
index 00000000000..95051cbe28b
--- /dev/null
+++ b/lib/public/Share_Backend_File_Dependent.php
@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal Nextcloud classes
+
+namespace OCP;
+
+/**
+ * Interface for share backends that share content that is dependent on files.
+ * Extends the Share_Backend interface.
+ * @since 5.0.0
+ */
+interface Share_Backend_File_Dependent extends Share_Backend {
+ /**
+ * Get the file path of the item
+ * @param string $itemSource
+ * @param string $uidOwner User that is the owner of shared item
+ * @return string|false
+ * @since 5.0.0
+ */
+ public function getFilePath($itemSource, $uidOwner);
+}