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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Filesystem\Io;
/**
* Input/output client interface
* @api
* @since 100.0.2
*/
interface IoInterface
{
/**
* Open a connection
*
* @param array $args
* @return bool
*/
public function open(array $args = []);
/**
* Close a connection
*
* @return bool
*/
public function close();
/**
* Create a directory
*
* @param string $dir
* @param int $mode
* @param bool $recursive
* @return bool
*/
public function mkdir($dir, $mode = 0777, $recursive = true);
/**
* Delete a directory
*
* @param string $dir
* @param bool $recursive
* @return bool
*/
public function rmdir($dir, $recursive = false);
/**
* Get current working directory
*
* @return string
*/
public function pwd();
/**
* Change current working directory
*
* @param string $dir
* @return bool
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
public function cd($dir);
/**
* Read a file
*
* @param string $filename
* @param string|resource|null $dest
* @return string|bool
*/
public function read($filename, $dest = null);
/**
* Write a file
*
* @param string $filename
* @param string|resource $src
* @param int|null $mode
* @return int|bool
*/
public function write($filename, $src, $mode = null);
/**
* Delete a file
*
* @param string $filename
* @return bool
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
public function rm($filename);
/**
* Rename or move a directory or a file
*
* @param string $src
* @param string $dest
* @return bool
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
public function mv($src, $dest);
/**
* Change mode of a directory or a file
*
* @param string $filename
* @param int $mode
* @return bool
*/
public function chmod($filename, $mode);
/**
* Get list of cwd subdirectories and files
*
* @param string|null $grep
* @return array
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
public function ls($grep = null);
/**
* Retrieve directory separator in context of io resource
*
* @return string
*/
public function dirsep();
}