You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
131 lines
2.7 KiB
131 lines
2.7 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Robin Appelman <robin@icewind.nl> |
|
* |
|
* @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; |
|
|
|
/** |
|
* A storage mounted to folder on the filesystem |
|
* @since 8.0.0 |
|
*/ |
|
interface IMountPoint { |
|
|
|
/** |
|
* get complete path to the mount point |
|
* |
|
* @return string |
|
* @since 8.0.0 |
|
*/ |
|
public function getMountPoint(); |
|
|
|
/** |
|
* Set the mountpoint |
|
* |
|
* @param string $mountPoint new mount point |
|
* @since 8.0.0 |
|
*/ |
|
public function setMountPoint($mountPoint); |
|
|
|
/** |
|
* Get the storage that is mounted |
|
* |
|
* @return \OC\Files\Storage\Storage |
|
* @since 8.0.0 |
|
*/ |
|
public function getStorage(); |
|
|
|
/** |
|
* Get the id of the storages |
|
* |
|
* @return string |
|
* @since 8.0.0 |
|
*/ |
|
public function getStorageId(); |
|
|
|
/** |
|
* Get the id of the storages |
|
* |
|
* @return int |
|
* @since 9.1.0 |
|
*/ |
|
public function getNumericStorageId(); |
|
|
|
/** |
|
* Get the path relative to the mountpoint |
|
* |
|
* @param string $path absolute path to a file or folder |
|
* @return string |
|
* @since 8.0.0 |
|
*/ |
|
public function getInternalPath($path); |
|
|
|
/** |
|
* Apply a storage wrapper to the mounted storage |
|
* |
|
* @param callable $wrapper |
|
* @since 8.0.0 |
|
*/ |
|
public function wrapStorage($wrapper); |
|
|
|
/** |
|
* Get a mount option |
|
* |
|
* @param string $name Name of the mount option to get |
|
* @param mixed $default Default value for the mount option |
|
* @return mixed |
|
* @since 8.0.0 |
|
*/ |
|
public function getOption($name, $default); |
|
|
|
/** |
|
* Get all options for the mount |
|
* |
|
* @return array |
|
* @since 8.1.0 |
|
*/ |
|
public function getOptions(); |
|
|
|
/** |
|
* Get the file id of the root of the storage |
|
* |
|
* @return int |
|
* @since 9.1.0 |
|
*/ |
|
public function getStorageRootId(); |
|
|
|
/** |
|
* Get the id of the configured mount |
|
* |
|
* @return int|null mount id or null if not applicable |
|
* @since 9.1.0 |
|
*/ |
|
public function getMountId(); |
|
|
|
/** |
|
* Get the type of mount point, used to distinguish things like shares and external storages |
|
* in the web interface |
|
* |
|
* @return string |
|
* @since 12.0.0 |
|
*/ |
|
public function getMountType(); |
|
}
|
|
|