From faf642c31d69ce66dbba6e4aaef2e1641f4bbf87 Mon Sep 17 00:00:00 2001
From: Robin Appelman <icewind@owncloud.com>
Date: Wed, 1 Jul 2015 15:57:04 +0200
Subject: expose the mount manager in the public api

---
 lib/public/files/mount/imountmanager.php | 83 ++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 lib/public/files/mount/imountmanager.php

(limited to 'lib/public/files')

diff --git a/lib/public/files/mount/imountmanager.php b/lib/public/files/mount/imountmanager.php
new file mode 100644
index 00000000000..ed7c9bf633f
--- /dev/null
+++ b/lib/public/files/mount/imountmanager.php
@@ -0,0 +1,83 @@
+<?php
+/**
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Files\Mount;
+
+interface IMountManager {
+
+	/**
+	 * @param \OCP\Files\Mount\IMountPoint $mount
+	 */
+	public function addMount(IMountPoint $mount);
+
+	/**
+	 * @param string $mountPoint
+	 */
+	public function removeMount($mountPoint);
+
+	/**
+	 * @param string $mountPoint
+	 * @param string $target
+	 */
+	public function moveMount($mountPoint, $target);
+
+	/**
+	 * Find the mount for $path
+	 *
+	 * @param string $path
+	 * @return \OCP\Files\Mount\IMountPoint
+	 */
+	public function find($path);
+
+	/**
+	 * Find all mounts in $path
+	 *
+	 * @param string $path
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function findIn($path);
+
+	/**
+	 * Remove all registered mounts
+	 */
+	public function clear();
+
+	/**
+	 * Find mounts by storage id
+	 *
+	 * @param string $id
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function findByStorageId($id);
+
+	/**
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function getAll();
+
+	/**
+	 * Find mounts by numeric storage id
+	 *
+	 * @param int $id
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function findByNumericId($id);
+}
-- 
cgit v1.2.3


From 207ce35ee99e72682b505d3f9d05ab61a6aa9524 Mon Sep 17 00:00:00 2001
From: Robin Appelman <icewind@owncloud.com>
Date: Wed, 1 Jul 2015 16:07:57 +0200
Subject: phpdoc

---
 lib/public/files/mount/imountmanager.php | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'lib/public/files')

diff --git a/lib/public/files/mount/imountmanager.php b/lib/public/files/mount/imountmanager.php
index ed7c9bf633f..96ec1e11ad3 100644
--- a/lib/public/files/mount/imountmanager.php
+++ b/lib/public/files/mount/imountmanager.php
@@ -21,21 +21,35 @@
 
 namespace OCP\Files\Mount;
 
+/**
+ * Interface IMountManager
+ *
+ * Manages all mounted storages in the system
+ */
 interface IMountManager {
 
 	/**
+	 * Add a new mount
+	 *
 	 * @param \OCP\Files\Mount\IMountPoint $mount
+	 * @since 8.2.0
 	 */
 	public function addMount(IMountPoint $mount);
 
 	/**
+	 * Remove a mount
+	 *
 	 * @param string $mountPoint
+	 * @since 8.2.0
 	 */
 	public function removeMount($mountPoint);
 
 	/**
+	 * Change the location of a mount
+	 *
 	 * @param string $mountPoint
 	 * @param string $target
+	 * @since 8.2.0
 	 */
 	public function moveMount($mountPoint, $target);
 
@@ -44,6 +58,7 @@ interface IMountManager {
 	 *
 	 * @param string $path
 	 * @return \OCP\Files\Mount\IMountPoint
+	 * @since 8.2.0
 	 */
 	public function find($path);
 
@@ -52,11 +67,14 @@ interface IMountManager {
 	 *
 	 * @param string $path
 	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.2.0
 	 */
 	public function findIn($path);
 
 	/**
 	 * Remove all registered mounts
+	 *
+	 * @since 8.2.0
 	 */
 	public function clear();
 
@@ -65,11 +83,13 @@ interface IMountManager {
 	 *
 	 * @param string $id
 	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.2.0
 	 */
 	public function findByStorageId($id);
 
 	/**
 	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.2.0
 	 */
 	public function getAll();
 
@@ -78,6 +98,7 @@ interface IMountManager {
 	 *
 	 * @param int $id
 	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.2.0
 	 */
 	public function findByNumericId($id);
 }
-- 
cgit v1.2.3