nextcloud/lib/public/files/mount/imountpoint.php

80 lines
1.8 KiB
PHP
Raw Normal View History

<?php
/**
2015-02-23 13:28:53 +03:00
* @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;
/**
* A storage mounted to folder on the filesystem
*/
interface IMountPoint {
/**
* get complete path to the mount point
*
* @return string
*/
public function getMountPoint();
/**
* Set the mountpoint
*
* @param string $mountPoint new mount point
*/
public function setMountPoint($mountPoint);
/**
* Get the storage that is mounted
*
* @return \OC\Files\Storage\Storage
*/
public function getStorage();
/**
* Get the id of the storages
*
* @return string
*/
public function getStorageId();
/**
* Get the path relative to the mountpoint
*
* @param string $path absolute path to a file or folder
* @return string
*/
public function getInternalPath($path);
/**
* Apply a storage wrapper to the mounted storage
*
* @param callable $wrapper
*/
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
*/
public function getOption($name, $default);
}