blob: 3c8e6e88ab3586bed9346012880d9aacb5dd9db1 (
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
|
<?php
/**
* @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Files\SimpleFS;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
/**
* Interface ISimpleFolder
*
* @since 11.0.0
*/
interface ISimpleFolder {
/**
* Get all the files in a folder
*
* @return ISimpleFile[]
* @since 11.0.0
*/
public function getDirectoryListing(): array;
/**
* Check if a file with $name exists
*
* @param string $name
* @return bool
* @since 11.0.0
*/
public function fileExists(string $name): bool;
/**
* Get the file named $name from the folder
*
* @throws NotFoundException
* @since 11.0.0
*/
public function getFile(string $name): ISimpleFile;
/**
* Creates a new file with $name in the folder
*
* @param string|resource|null $content @since 19.0.0
* @throws NotPermittedException
* @since 11.0.0
*/
public function newFile(string $name, $content = null): ISimpleFile;
/**
* Remove the folder and all the files in it
*
* @throws NotPermittedException
* @since 11.0.0
*/
public function delete(): void;
/**
* Get the folder name
*
* @since 11.0.0
*/
public function getName(): string;
}
|
