mirror of
https://github.com/nextcloud/server.git
synced 2025-02-24 17:06:50 +00:00
4d110c1dd6
this should be enough in most(?) cases and makes efficient implementation and caching easier Signed-off-by: Robin Appelman <robin@icewind.nl>
101 lines
2.8 KiB
PHP
101 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
*
|
|
* @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;
|
|
|
|
use OC\Hooks\Emitter;
|
|
use OC\User\NoUserException;
|
|
use OCP\Files\Cache\ICacheEntry;
|
|
use OCP\Files\Mount\IMountPoint;
|
|
use OCP\Files\Node as INode;
|
|
|
|
/**
|
|
* Interface IRootFolder
|
|
*
|
|
* @since 8.0.0
|
|
*/
|
|
interface IRootFolder extends Folder, Emitter {
|
|
/**
|
|
* Returns a view to user's files folder
|
|
*
|
|
* @param string $userId user ID
|
|
* @return Folder
|
|
* @throws NoUserException
|
|
* @throws NotPermittedException
|
|
*
|
|
* @since 8.2.0
|
|
*/
|
|
public function getUserFolder($userId);
|
|
|
|
/**
|
|
* Get a file or folder by fileid, inside a parent path
|
|
*
|
|
* @param int $id
|
|
* @param string $path
|
|
* @return Node[]
|
|
*
|
|
* @since 24.0.0
|
|
*/
|
|
public function getByIdInPath(int $id, string $path);
|
|
|
|
/**
|
|
* get a file or folder inside the folder by its internal id
|
|
*
|
|
* Unlike getByIdInPath, this method only returns a single node even if the user has
|
|
* access to the file with the requested id multiple times.
|
|
*
|
|
* This method provides no guarantee about which of the nodes in returned and the
|
|
* returned node might, for example, have less permissions than other nodes for the same file
|
|
*
|
|
* Apps that require accurate information about the users access to the file should use getByIdInPath
|
|
* instead of pick the correct node out of the result.
|
|
*
|
|
* @param int $id
|
|
* @return Node|null
|
|
* @since 29.0.0
|
|
*/
|
|
public function getFirstNodeByIdInPath(int $id, string $path): ?Node;
|
|
|
|
/**
|
|
* @return IMountPoint[]
|
|
*
|
|
* @since 28.0.0
|
|
*/
|
|
public function getMountsIn(string $mountPoint): array;
|
|
|
|
/**
|
|
* Create a `Node` for a file or folder from the cache entry and mountpoint
|
|
*
|
|
* @param ICacheEntry $cacheEntry
|
|
* @param IMountPoint $mountPoint
|
|
* @return Node
|
|
* @since 28.0.0
|
|
*/
|
|
public function getNodeFromCacheEntryAndMount(ICacheEntry $cacheEntry, IMountPoint $mountPoint): INode;
|
|
|
|
/**
|
|
* @since 28.0.0
|
|
*/
|
|
public function getMount(string $mountPoint): IMountPoint;
|
|
}
|