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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Filesystem\File;
use Magento\Framework\Filesystem\DriverInterface;
use Magento\Framework\Exception\FileSystemException;
class Read implements ReadInterface
{
/**
* Full path to file
*
* @var string
*/
protected $path;
/**
* Mode to open the file
*
* @var string
*/
protected $mode = 'r';
/**
* Opened file resource
*
* @var resource
*/
protected $resource;
/**
* @var \Magento\Framework\Filesystem\DriverInterface
*/
protected $driver;
/**
* Constructor
*
* @param string $path
* @param DriverInterface $driver
*/
public function __construct($path, DriverInterface $driver)
{
$this->path = $path;
$this->driver = $driver;
$this->open();
}
/**
* Open file
*
* @return $this
*/
protected function open()
{
$this->assertValid();
$this->resource = $this->driver->fileOpen($this->path, $this->mode);
return $this;
}
/**
* Assert file existence
*
* @return bool
* @throws \Magento\Framework\Exception\FileSystemException
*/
protected function assertValid()
{
if (!$this->driver->isExists($this->path)) {
throw new FileSystemException(
new \Magento\Framework\Phrase('The "%1" file doesn\'t exist.', [$this->path])
);
}
return true;
}
/**
* Reads the specified number of bytes from the current position.
*
* @param int $length The number of bytes to read
* @return string
*/
public function read($length)
{
return $this->driver->fileRead($this->resource, $length);
}
/**
* Return file content
*
* @param string|null $flag
* @param resource|null $context
* @return string
*/
public function readAll($flag = null, $context = null)
{
return $this->driver->fileGetContents($this->path, $flag, $context);
}
/**
* Reads the line with specified number of bytes from the current position.
*
* @param int $length The number of bytes to read
* @param string $ending [optional]
* @return string
*/
public function readLine($length, $ending = null)
{
return $this->driver->fileReadLine($this->resource, $length, $ending);
}
/**
* Reads one CSV row from the file
*
* @param int $length [optional]
* @param string $delimiter [optional]
* @param string $enclosure [optional]
* @param string $escape [optional]
* @return array|bool|null
*/
public function readCsv($length = 0, $delimiter = ',', $enclosure = '"', $escape = '\\')
{
return $this->driver->fileGetCsv($this->resource, $length, $delimiter, $enclosure, $escape);
}
/**
* Returns the current cursor position
*
* @return int
*/
public function tell()
{
return $this->driver->fileTell($this->resource);
}
/**
* Seeks to the specified offset
*
* @param int $offset
* @param int $whence
* @return int
*/
public function seek($offset, $whence = SEEK_SET)
{
return $this->driver->fileSeek($this->resource, $offset, $whence);
}
/**
* Checks if the current position is the end-of-file
*
* @return bool
*/
public function eof()
{
return $this->driver->endOfFile($this->resource);
}
/**
* Closes the file.
*
* @return bool
*/
public function close()
{
return $this->driver->fileClose($this->resource);
}
/**
* {@inheritDoc}
*
* @return array
*/
public function stat()
{
return $this->driver->stat($this->path);
}
}