| 148 |
lars |
1 |
<?php
|
|
|
2 |
|
|
|
3 |
/**
|
|
|
4 |
* Hoa
|
|
|
5 |
*
|
|
|
6 |
*
|
|
|
7 |
* @license
|
|
|
8 |
*
|
|
|
9 |
* New BSD License
|
|
|
10 |
*
|
|
|
11 |
* Copyright © 2007-2017, Hoa community. All rights reserved.
|
|
|
12 |
*
|
|
|
13 |
* Redistribution and use in source and binary forms, with or without
|
|
|
14 |
* modification, are permitted provided that the following conditions are met:
|
|
|
15 |
* * Redistributions of source code must retain the above copyright
|
|
|
16 |
* notice, this list of conditions and the following disclaimer.
|
|
|
17 |
* * Redistributions in binary form must reproduce the above copyright
|
|
|
18 |
* notice, this list of conditions and the following disclaimer in the
|
|
|
19 |
* documentation and/or other materials provided with the distribution.
|
|
|
20 |
* * Neither the name of the Hoa nor the names of its contributors may be
|
|
|
21 |
* used to endorse or promote products derived from this software without
|
|
|
22 |
* specific prior written permission.
|
|
|
23 |
*
|
|
|
24 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
25 |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
26 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
27 |
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
|
|
|
28 |
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
29 |
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
30 |
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
31 |
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
32 |
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
33 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
34 |
* POSSIBILITY OF SUCH DAMAGE.
|
|
|
35 |
*/
|
|
|
36 |
|
|
|
37 |
namespace Psy\Readline\Hoa;
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Class \Hoa\File\Read.
|
|
|
41 |
*
|
|
|
42 |
* File handler.
|
|
|
43 |
*/
|
|
|
44 |
class FileRead extends File implements StreamIn
|
|
|
45 |
{
|
|
|
46 |
/**
|
|
|
47 |
* Open a file.
|
|
|
48 |
*/
|
|
|
49 |
public function __construct(
|
|
|
50 |
string $streamName,
|
|
|
51 |
string $mode = parent::MODE_READ,
|
|
|
52 |
string $context = null,
|
|
|
53 |
bool $wait = false
|
|
|
54 |
) {
|
|
|
55 |
parent::__construct($streamName, $mode, $context, $wait);
|
|
|
56 |
|
|
|
57 |
return;
|
|
|
58 |
}
|
|
|
59 |
|
|
|
60 |
/**
|
|
|
61 |
* Open the stream and return the associated resource.
|
|
|
62 |
*/
|
|
|
63 |
protected function &_open(string $streamName, StreamContext $context = null)
|
|
|
64 |
{
|
|
|
65 |
static $createModes = [
|
|
|
66 |
parent::MODE_READ,
|
|
|
67 |
];
|
|
|
68 |
|
|
|
69 |
if (!\in_array($this->getMode(), $createModes)) {
|
|
|
70 |
throw new FileException('Open mode are not supported; given %d. Only %s are supported.', 0, [$this->getMode(), \implode(', ', $createModes)]);
|
|
|
71 |
}
|
|
|
72 |
|
|
|
73 |
\preg_match('#^(\w+)://#', $streamName, $match);
|
|
|
74 |
|
|
|
75 |
if (((isset($match[1]) && $match[1] === 'file') || !isset($match[1])) &&
|
|
|
76 |
!\file_exists($streamName)) {
|
|
|
77 |
throw new FileDoesNotExistException('File %s does not exist.', 1, $streamName);
|
|
|
78 |
}
|
|
|
79 |
|
|
|
80 |
$out = parent::_open($streamName, $context);
|
|
|
81 |
|
|
|
82 |
return $out;
|
|
|
83 |
}
|
|
|
84 |
|
|
|
85 |
/**
|
|
|
86 |
* Test for end-of-file.
|
|
|
87 |
*/
|
|
|
88 |
public function eof(): bool
|
|
|
89 |
{
|
|
|
90 |
return \feof($this->getStream());
|
|
|
91 |
}
|
|
|
92 |
|
|
|
93 |
/**
|
|
|
94 |
* Read n characters.
|
|
|
95 |
*/
|
|
|
96 |
public function read(int $length)
|
|
|
97 |
{
|
|
|
98 |
if (0 > $length) {
|
|
|
99 |
throw new FileException('Length must be greater than 0, given %d.', 2, $length);
|
|
|
100 |
}
|
|
|
101 |
|
|
|
102 |
return \fread($this->getStream(), $length);
|
|
|
103 |
}
|
|
|
104 |
|
|
|
105 |
/**
|
|
|
106 |
* Alias of $this->read().
|
|
|
107 |
*/
|
|
|
108 |
public function readString(int $length)
|
|
|
109 |
{
|
|
|
110 |
return $this->read($length);
|
|
|
111 |
}
|
|
|
112 |
|
|
|
113 |
/**
|
|
|
114 |
* Read a character.
|
|
|
115 |
*/
|
|
|
116 |
public function readCharacter()
|
|
|
117 |
{
|
|
|
118 |
return \fgetc($this->getStream());
|
|
|
119 |
}
|
|
|
120 |
|
|
|
121 |
/**
|
|
|
122 |
* Read a boolean.
|
|
|
123 |
*/
|
|
|
124 |
public function readBoolean()
|
|
|
125 |
{
|
|
|
126 |
return (bool) $this->read(1);
|
|
|
127 |
}
|
|
|
128 |
|
|
|
129 |
/**
|
|
|
130 |
* Read an integer.
|
|
|
131 |
*/
|
|
|
132 |
public function readInteger(int $length = 1)
|
|
|
133 |
{
|
|
|
134 |
return (int) $this->read($length);
|
|
|
135 |
}
|
|
|
136 |
|
|
|
137 |
/**
|
|
|
138 |
* Read a float.
|
|
|
139 |
*/
|
|
|
140 |
public function readFloat(int $length = 1)
|
|
|
141 |
{
|
|
|
142 |
return (float) $this->read($length);
|
|
|
143 |
}
|
|
|
144 |
|
|
|
145 |
/**
|
|
|
146 |
* Read an array.
|
|
|
147 |
* Alias of the $this->scanf() method.
|
|
|
148 |
*/
|
|
|
149 |
public function readArray(string $format = null)
|
|
|
150 |
{
|
|
|
151 |
return $this->scanf($format);
|
|
|
152 |
}
|
|
|
153 |
|
|
|
154 |
/**
|
|
|
155 |
* Read a line.
|
|
|
156 |
*/
|
|
|
157 |
public function readLine()
|
|
|
158 |
{
|
|
|
159 |
return \fgets($this->getStream());
|
|
|
160 |
}
|
|
|
161 |
|
|
|
162 |
/**
|
|
|
163 |
* Read all, i.e. read as much as possible.
|
|
|
164 |
*/
|
|
|
165 |
public function readAll(int $offset = 0)
|
|
|
166 |
{
|
|
|
167 |
return \stream_get_contents($this->getStream(), -1, $offset);
|
|
|
168 |
}
|
|
|
169 |
|
|
|
170 |
/**
|
|
|
171 |
* Parse input from a stream according to a format.
|
|
|
172 |
*/
|
|
|
173 |
public function scanf(string $format): array
|
|
|
174 |
{
|
|
|
175 |
return \fscanf($this->getStream(), $format);
|
|
|
176 |
}
|
|
|
177 |
}
|