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

106 lines
2.1 KiB
PHP
Raw Normal View History

<?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;
2015-07-01 17:07:57 +03:00
/**
* Interface IMountManager
*
* Manages all mounted storages in the system
2015-07-27 11:49:26 +03:00
* @since 8.2.0
2015-07-01 17:07:57 +03:00
*/
interface IMountManager {
/**
2015-07-01 17:07:57 +03:00
* Add a new mount
*
* @param \OCP\Files\Mount\IMountPoint $mount
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function addMount(IMountPoint $mount);
/**
2015-07-01 17:07:57 +03:00
* Remove a mount
*
* @param string $mountPoint
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function removeMount($mountPoint);
/**
2015-07-01 17:07:57 +03:00
* Change the location of a mount
*
* @param string $mountPoint
* @param string $target
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function moveMount($mountPoint, $target);
/**
* Find the mount for $path
*
* @param string $path
* @return \OCP\Files\Mount\IMountPoint
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function find($path);
/**
* Find all mounts in $path
*
* @param string $path
* @return \OCP\Files\Mount\IMountPoint[]
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function findIn($path);
/**
* Remove all registered mounts
2015-07-01 17:07:57 +03:00
*
* @since 8.2.0
*/
public function clear();
/**
* Find mounts by storage id
*
* @param string $id
* @return \OCP\Files\Mount\IMountPoint[]
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function findByStorageId($id);
/**
* @return \OCP\Files\Mount\IMountPoint[]
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function getAll();
/**
* Find mounts by numeric storage id
*
* @param int $id
* @return \OCP\Files\Mount\IMountPoint[]
2015-07-01 17:07:57 +03:00
* @since 8.2.0
*/
public function findByNumericId($id);
}