blob: ec68ed475c51545fb5e486655cc71ef66b54dd17 (
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP\Files;
interface FileInfo {
const TYPE_FILE = 'file';
const TYPE_FOLDER = 'dir';
/*
* @const \OCP\Files\FileInfo::SPACE_NOT_COMPUTED Return value for a not computed space value
*/
const SPACE_NOT_COMPUTED = -1;
/*
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unknown space value
*/
const SPACE_UNKNOWN = -2;
/*
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unlimited space
*/
const SPACE_UNLIMITED = -3;
/**
* Get the Etag of the file or folder
*
* @return string
*/
public function getEtag();
/**
* Get the size in bytes for the file or folder
*
* @return int
*/
public function getSize();
/**
* Get the last modified date as timestamp for the file or folder
*
* @return int
*/
public function getMtime();
/**
* Get the name of the file or folder
*
* @return string
*/
public function getName();
/**
* Get the path relative to the storage
*
* @return string
*/
public function getInternalPath();
/**
* Get the absolute path
*
* @return string
*/
public function getPath();
/**
* Get the full mimetype of the file or folder i.e. 'image/png'
*
* @return string
*/
public function getMimetype();
/**
* Get the first part of the mimetype of the file or folder i.e. 'image'
*
* @return string
*/
public function getMimePart();
/**
* Get the storage the file or folder is storage on
*
* @return \OCP\Files\Storage
*/
public function getStorage();
/**
* Get the file id of the file or folder
*
* @return int
*/
public function getId();
/**
* Check whether the file is encrypted
*
* @return bool
*/
public function isEncrypted();
/**
* Get the permissions of the file or folder as bitmasked combination of the following constants
* \OCP\Constants::PERMISSION_CREATE
* \OCP\Constants::PERMISSION_READ
* \OCP\Constants::PERMISSION_UPDATE
* \OCP\Constants::PERMISSION_DELETE
* \OCP\Constants::PERMISSION_SHARE
* \OCP\Constants::PERMISSION_ALL
*
* @return int
*/
public function getPermissions();
/**
* Check whether this is a file or a folder
*
* @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
*/
public function getType();
/**
* Check if the file or folder is readable
*
* @return bool
*/
public function isReadable();
/**
* Check if a file is writable
*
* @return bool
*/
public function isUpdateable();
/**
* Check whether new files or folders can be created inside this folder
*
* @return bool
*/
public function isCreatable();
/**
* Check if a file or folder can be deleted
*
* @return bool
*/
public function isDeletable();
/**
* Check if a file or folder can be shared
*
* @return bool
*/
public function isShareable();
/**
* Check if a file or folder is shared
*
* @return bool
*/
public function isShared();
/**
* Check if a file or folder is mounted
*
* @return bool
*/
public function isMounted();
/**
* Get the mountpoint the file belongs to
*
* @return \OCP\Files\Mount\IMountPoint
*/
public function getMountPoint();
}
|
