91 lines
2.2 KiB
PHP
91 lines
2.2 KiB
PHP
|
<?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\Config;
|
||
|
|
|
||
|
|
use OCP\IUser;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Manages the different mount providers
|
||
|
|
* @since 8.0.0
|
||
|
|
*/
|
||
|
|
interface IMountProviderCollection {
|
||
|
|
/**
|
||
|
|
* Get all configured mount points for the user
|
||
|
|
*
|
||
|
|
* @param \OCP\IUser $user
|
||
|
|
* @return \OCP\Files\Mount\IMountPoint[]
|
||
|
|
* @since 8.0.0
|
||
|
|
*/
|
||
|
|
public function getMountsForUser(IUser $user);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the configured home mount for this user
|
||
|
|
*
|
||
|
|
* @param \OCP\IUser $user
|
||
|
|
* @return \OCP\Files\Mount\IMountPoint
|
||
|
|
* @since 9.1.0
|
||
|
|
*/
|
||
|
|
public function getHomeMountForUser(IUser $user);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add a provider for mount points
|
||
|
|
*
|
||
|
|
* @param \OCP\Files\Config\IMountProvider $provider
|
||
|
|
* @since 8.0.0
|
||
|
|
*/
|
||
|
|
public function registerProvider(IMountProvider $provider);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add a filter for mounts
|
||
|
|
*
|
||
|
|
* @param callable $filter (IMountPoint $mountPoint, IUser $user) => boolean
|
||
|
|
* @since 14.0.0
|
||
|
|
*/
|
||
|
|
public function registerMountFilter(callable $filter);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add a provider for home mount points
|
||
|
|
*
|
||
|
|
* @param \OCP\Files\Config\IHomeMountProvider $provider
|
||
|
|
* @since 9.1.0
|
||
|
|
*/
|
||
|
|
public function registerHomeProvider(IHomeMountProvider $provider);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the mount cache which can be used to search for mounts without setting up the filesystem
|
||
|
|
*
|
||
|
|
* @return IUserMountCache
|
||
|
|
* @since 9.0.0
|
||
|
|
*/
|
||
|
|
public function getMountCache();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all root mountpoints
|
||
|
|
*
|
||
|
|
* @return \OCP\Files\Mount\IMountPoint[]
|
||
|
|
* @since 20.0.0
|
||
|
|
*/
|
||
|
|
public function getRootMounts(): array;
|
||
|
|
}
|