forked from hoaproject/File
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Read.php
259 lines (215 loc) · 6.45 KB
/
Read.php
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
<?php
/**
* Hoa
*
*
* @license
*
* New BSD License
*
* Copyright © 2007-2014, Ivan Enderlin. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Hoa nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace {
from('Hoa')
/**
* \Hoa\File\Exception
*/
-> import('File.Exception.~')
/**
* \Hoa\File
*/
-> import('File.~')
/**
* \Hoa\Stream\IStream\In
*/
-> import('Stream.I~.In');
}
namespace Hoa\File {
/**
* Class \Hoa\File\Read.
*
* File handler.
*
* @author Ivan Enderlin <ivan.enderlin@hoa-project.net>
* @copyright Copyright © 2007-2014 Ivan Enderlin.
* @license New BSD License
*/
class Read extends File implements \Hoa\Stream\IStream\In {
/**
* Open a file.
*
* @access public
* @param string $streamName Stream name.
* @param string $mode Open mode, see the self::MODE_* constants.
* @param string $context Context ID (please, see the
* \Hoa\Stream\Context class).
* @param bool $wait Differ opening or not.
* @return void
*/
public function __construct ( $streamName, $mode = parent::MODE_READ,
$context = null, $wait = false ) {
parent::__construct($streamName, $mode, $context, $wait);
return;
}
/**
* Open the stream and return the associated resource.
*
* @access protected
* @param string $streamName Stream name (e.g. path or URL).
* @param \Hoa\Stream\Context $context Context.
* @return resource
* @throw \Hoa\File\Exception\FileDoesNotExist
* @throw \Hoa\File\Exception
*/
protected function &_open ( $streamName, \Hoa\Stream\Context $context = null ) {
static $createModes = array(
parent::MODE_READ
);
if(!in_array($this->getMode(), $createModes))
throw new Exception(
'Open mode are not supported; given %d. Only %s are supported.',
0, array($this->getMode(), implode(', ', $createModes)));
preg_match('#^(\w+)://#', $streamName, $match);
if(( (isset($match[1]) && $match[1] == 'file') || !isset($match[1]))
&& !file_exists($streamName))
throw new Exception\FileDoesNotExist(
'File %s does not exist.', 1, $streamName);
$out = parent::_open($streamName, $context);
return $out;
}
/**
* Test for end-of-file.
*
* @access public
* @return bool
*/
public function eof ( ) {
return feof($this->getStream());
}
/**
* Read n characters.
*
* @access public
* @param int $length Length.
* @return string
* @throw \Hoa\File\Exception
*/
public function read ( $length ) {
if(0 > $length)
throw new Exception(
'Length must be greater than 0, given %d.', 2, $length);
return fread($this->getStream(), $length);
}
/**
* Alias of $this->read().
*
* @access public
* @param int $length Length.
* @return string
*/
public function readString ( $length ) {
return $this->read($length);
}
/**
* Read a character.
*
* @access public
* @return string
*/
public function readCharacter ( ) {
return fgetc($this->getStream());
}
/**
* Read a boolean.
*
* @access public
* @return bool
*/
public function readBoolean ( ) {
return (bool) $this->read(1);
}
/**
* Read an integer.
*
* @access public
* @param int $length Length.
* @return int
*/
public function readInteger ( $length = 1 ) {
return (int) $this->read($length);
}
/**
* Read a float.
*
* @access public
* @param int $length Length.
* @return float
*/
public function readFloat ( $length = 1 ) {
return (float) $this->read($length);
}
/**
* Read an array.
* Alias of the $this->scanf() method.
*
* @access public
* @param string $format Format (see printf's formats).
* @return array
*/
public function readArray ( $format = null ) {
return $this->scanf($format);
}
/**
* Read a line.
*
* @access public
* @return string
*/
public function readLine ( ) {
return fgets($this->getStream());
}
/**
* Read all, i.e. read as much as possible.
*
* @access public
* @param int $offset Offset.
* @return string
*/
public function readAll ( $offset = 0 ) {
return stream_get_contents($this->getStream(), -1, $offset);
}
/**
* Parse input from a stream according to a format.
*
* @access public
* @param string $format Format (see printf's formats).
* @return array
*/
public function scanf ( $format ) {
return fscanf($this->getStream(), $format);
}
}
}