mirror of
https://github.com/nextcloud/server.git
synced 2024-12-29 16:38:28 +00:00
81 lines
1.5 KiB
PHP
81 lines
1.5 KiB
PHP
<?php
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
namespace OCP\Files\Config;
|
|
|
|
use OCP\Files\Node;
|
|
use OCP\IUser;
|
|
|
|
/**
|
|
* Holds information about a mount for a user
|
|
*
|
|
* @since 9.0.0
|
|
*/
|
|
interface ICachedMountInfo {
|
|
/**
|
|
* @return IUser
|
|
* @since 9.0.0
|
|
*/
|
|
public function getUser(): IUser;
|
|
|
|
/**
|
|
* @return int the numeric storage id of the mount
|
|
* @since 9.0.0
|
|
*/
|
|
public function getStorageId(): int;
|
|
|
|
/**
|
|
* @return int the fileid of the root of the mount
|
|
* @since 9.0.0
|
|
*/
|
|
public function getRootId(): int;
|
|
|
|
/**
|
|
* @return Node|null the root node of the mount
|
|
* @since 9.0.0
|
|
*/
|
|
public function getMountPointNode(): ?Node;
|
|
|
|
/**
|
|
* @return string the mount point of the mount for the user
|
|
* @since 9.0.0
|
|
*/
|
|
public function getMountPoint(): string;
|
|
|
|
/**
|
|
* Get the id of the configured mount
|
|
*
|
|
* @return int|null mount id or null if not applicable
|
|
* @since 9.1.0
|
|
*/
|
|
public function getMountId(): ?int;
|
|
|
|
/**
|
|
* Get the internal path (within the storage) of the root of the mount
|
|
*
|
|
* @return string
|
|
* @since 11.0.0
|
|
*/
|
|
public function getRootInternalPath(): string;
|
|
|
|
/**
|
|
* Get the class of the mount provider that this mount originates from
|
|
*
|
|
* @return string
|
|
* @since 24.0.0
|
|
*/
|
|
public function getMountProvider(): string;
|
|
|
|
/**
|
|
* Get a key that uniquely identifies the mount
|
|
*
|
|
* @return string
|
|
* @since 28.0.0
|
|
*/
|
|
public function getKey(): string;
|
|
}
|