blob: fb8532f8c81531d231f6b54cb136919b6bd2ccc8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?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;
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;
/**
* @return string
* @since 30.0.0
*/
public function getAppDataDirectoryName(): string;
}
|
