-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDriverInterface.php
More file actions
342 lines (306 loc) · 8.36 KB
/
DriverInterface.php
File metadata and controls
342 lines (306 loc) · 8.36 KB
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<?php
/**
* @see https://github.com/codenomdev/codeigniter4-framework for the canonical source repository
*
* @copyright 2020 - Codenom Dev (https://codenom.com).
* @license https://github.com/codenomdev/codeigniter4-framework/blob/master/LICENSE MIT License
*/
namespace Codenom\Framework\Drive;
interface DriverInterface
{
/**
* Permissions to give read/write/execute access to owner and owning group, but not to all users
*
* @deprecated
*/
const WRITEABLE_DIRECTORY_MODE = 0770;
/**
* Permissions to give read/write access to owner and owning group, but not to all users
*
* @deprecated
*/
const WRITEABLE_FILE_MODE = 0660;
/**
* Retrieve file contents from given path
*
* @param string $path
* @param string|null $flag
* @param resource|null $context
* @return string
* @throws FileSystemException
*/
public function fileGetContents($path, $flag = null, $context = null);
/**
* Put contents into given file
*
* @param string $path
* @param string $content
* @param string|null $mode
* @return int The number of bytes that were written.
* @throws FileSystemException
*/
public function filePutContents($path, $content, $mode = null);
/**
* Tells whether the filename is a regular file
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isFile($path);
/**
* Check if given path is writable
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isWritable($path);
/**
* Is file or directory exist in file system
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isExists($path);
/**
* Tells whether the filename is a regular directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isDirectory($path);
/**
* Check permissions for reading file or directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isReadable($path);
/**
* Returns parent directory's path
*
* @param string $path
* @return string
*/
public function getParentDirectory($path);
/**
* Create directory
*
* @param string $path
* @param int $permissions
* @return bool
* @throws FileSystemException
*/
public function createDirectory($path, $permissions = 0777);
/**
* Attempts to locate a file by examining the name for a namespace
* and looking through the PSR-4 namespaced files that we know about.
*
* @param string $file The namespaced file to locate
* @param string $folder The folder within the namespace that we should look for the file.
* @param string $ext The file extension the file should have.
*
* @return string|false The path to the file, or false if not found.
*/
public function readDirectory($file, $folder, $ext = 'php');
/**
* Searches through all of the defined namespaces looking for a file.
* Returns an array of all found locations for the defined file.
*
* Example:
*
* $locator->search('Config/Routes.php');
* // Assuming PSR4 namespaces include foo and bar, might return:
* [
* 'app/Modules/foo/Config/Routes.php',
* 'app/Modules/bar/Config/Routes.php',
* ]
*
* @param string $path
* @param string $ext
* @param boolean $prioritizeApp
*
* @return array
*/
public function search(string $path, string $ext, bool $prioritizeApp);
/**
* Renames a file or directory
*
* @param string $oldPath
* @param string $newPath
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function rename($oldPath, $newPath, DriverInterface $targetDriver = null);
/**
* Copy source into destination
*
* @param string $source
* @param string $destination
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function copy($source, $destination, DriverInterface $targetDriver = null);
/**
* Create symlink on source and place it into destination
*
* @param string $source
* @param string $destination
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function symlink($source, $destination, DriverInterface $targetDriver = null);
/**
* Delete file
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function deleteFile($path);
/**
* Delete directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function deleteDirectory($path);
/**
* Change permissions of given path
*
* @param string $path
* @param int $permissions
* @return bool
* @throws FileSystemException
*/
public function changePermissions($path, $permissions);
/**
* Recursively hange permissions of given path
*
* @param string $path
* @param int $dirPermissions
* @param int $filePermissions
* @return bool
* @throws FileSystemException
*/
public function changePermissionsRecursively($path, $dirPermissions, $filePermissions);
/**
* Sets access and modification time of file.
*
* @param string $path
* @param int|null $modificationTime
* @return bool
* @throws FileSystemException
*/
public function touch($path, $modificationTime = null);
/**
* Open file
*
* @param string $path
* @param string $mode
* @return resource
* @throws FileSystemException
*/
public function fileOpen($path, $mode);
/**
* Reads the line content from file pointer (with specified number of bytes from the current position).
*
* @param resource $resource
* @param int $length
* @param string $ending [optional]
* @return string
* @throws FileSystemException
*/
public function fileReadLine($resource, $length, $ending = null);
/**
* Reads the specified number of bytes from the current position.
*
* @param resource $resource
* @param int $length
* @return string
* @throws FileSystemException
*/
public function fileRead($resource, $length);
/**
* Returns true if pointer at the end of file or in case of exception
*
* @param resource $resource
* @return boolean
*/
public function endOfFile($resource);
/**
* Close file
*
* @param resource $resource
* @return boolean
* @throws FileSystemException
*/
public function fileClose($resource);
/**
* Writes data to file
*
* @param resource $resource
* @param string $data
* @return int
* @throws FileSystemException
*/
public function fileWrite($resource, $data);
/**
* Flushes the output
*
* @param resource $resource
* @return bool
* @throws FileSystemException
*/
public function fileFlush($resource);
/**
* Lock file in selected mode
*
* @param resource $resource
* @param int $lockMode
* @return bool
* @throws FileSystemException
*/
public function fileLock($resource, $lockMode = LOCK_EX);
/**
* Unlock file
*
* @param resource $resource
* @return bool
* @throws FileSystemException
*/
public function fileUnlock($resource);
/**
* @param string $basePath
* @param string $path
* @param string|null $scheme
* @return mixed
*/
public function getAbsolutePath($basePath, $path, $scheme = null);
/**
* @param string $path
* @return mixed
*/
public function getRealPath($path);
/**
* Return correct path for link
*
* @param string $path
* @return mixed
*/
public function getRealPathSafety($path);
/**
* @param string $basePath
* @param null $path
* @return mixed
*/
public function getRelativePath($basePath, $path = null);
}