1
|
|
|
<?php |
2
|
|
|
namespace Subreality\Dilmun\Anshar\Http; |
3
|
|
|
|
4
|
|
|
use Psr\Http\Message\StreamInterface; |
5
|
|
|
|
6
|
|
|
/** |
7
|
|
|
* Class Stream |
8
|
|
|
* @package Subreality\Dilmun\Anshar\Http |
9
|
|
|
*/ |
10
|
|
|
class Stream implements StreamInterface |
11
|
|
|
{ |
12
|
1 |
|
public function __construct($resource) |
13
|
|
|
{ |
14
|
1 |
|
if (!is_resource($resource)) { |
15
|
1 |
|
throw new \InvalidArgumentException("Stream must be created with a resource"); |
16
|
|
|
} |
17
|
|
|
} |
18
|
|
|
|
19
|
|
|
/** |
20
|
|
|
* Reads all data from the stream into a string, from the beginning to end. |
21
|
|
|
* |
22
|
|
|
* This method MUST attempt to seek to the beginning of the stream before |
23
|
|
|
* reading data and read the stream until the end is reached. |
24
|
|
|
* |
25
|
|
|
* Warning: This could attempt to load a large amount of data into memory. |
26
|
|
|
* |
27
|
|
|
* This method MUST NOT raise an exception in order to conform with PHP's |
28
|
|
|
* string casting operations. |
29
|
|
|
* |
30
|
|
|
* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring |
31
|
|
|
* @return string |
|
|
|
|
32
|
|
|
*/ |
33
|
|
|
public function __toString() |
34
|
|
|
{ |
35
|
|
|
// TODO: Implement __toString() method. |
|
|
|
|
36
|
|
|
} |
37
|
|
|
|
38
|
|
|
/** |
39
|
|
|
* Closes the stream and any underlying resources. |
40
|
|
|
* |
41
|
|
|
* @return void |
42
|
|
|
*/ |
43
|
|
|
public function close() |
44
|
|
|
{ |
45
|
|
|
// TODO: Implement close() method. |
|
|
|
|
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* Separates any underlying resources from the stream. |
50
|
|
|
* |
51
|
|
|
* After the stream has been detached, the stream is in an unusable state. |
52
|
|
|
* |
53
|
|
|
* @return resource|null Underlying PHP stream, if any |
54
|
|
|
*/ |
55
|
|
|
public function detach() |
56
|
|
|
{ |
57
|
|
|
// TODO: Implement detach() method. |
|
|
|
|
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* Get the size of the stream if known. |
62
|
|
|
* |
63
|
|
|
* @return int|null Returns the size in bytes if known, or null if unknown. |
64
|
|
|
*/ |
65
|
|
|
public function getSize() |
66
|
|
|
{ |
67
|
|
|
// TODO: Implement getSize() method. |
|
|
|
|
68
|
|
|
} |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* Returns the current position of the file read/write pointer |
72
|
|
|
* |
73
|
|
|
* @return int Position of the file pointer |
|
|
|
|
74
|
|
|
* @throws \RuntimeException on error. |
75
|
|
|
*/ |
76
|
|
|
public function tell() |
77
|
|
|
{ |
78
|
|
|
// TODO: Implement tell() method. |
|
|
|
|
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
/** |
82
|
|
|
* Returns true if the stream is at the end of the stream. |
83
|
|
|
* |
84
|
|
|
* @return bool |
|
|
|
|
85
|
|
|
*/ |
86
|
|
|
public function eof() |
87
|
|
|
{ |
88
|
|
|
// TODO: Implement eof() method. |
|
|
|
|
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* Returns whether or not the stream is seekable. |
93
|
|
|
* |
94
|
|
|
* @return bool |
|
|
|
|
95
|
|
|
*/ |
96
|
|
|
public function isSeekable() |
97
|
|
|
{ |
98
|
|
|
// TODO: Implement isSeekable() method. |
|
|
|
|
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* Seek to a position in the stream. |
103
|
|
|
* |
104
|
|
|
* @link http://www.php.net/manual/en/function.fseek.php |
105
|
|
|
* @param int $offset Stream offset |
106
|
|
|
* @param int $whence Specifies how the cursor position will be calculated |
107
|
|
|
* based on the seek offset. Valid values are identical to the built-in |
108
|
|
|
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to |
109
|
|
|
* offset bytes SEEK_CUR: Set position to current location plus offset |
110
|
|
|
* SEEK_END: Set position to end-of-stream plus offset. |
111
|
|
|
* @throws \RuntimeException on failure. |
112
|
|
|
*/ |
113
|
|
|
public function seek($offset, $whence = SEEK_SET) |
114
|
|
|
{ |
115
|
|
|
// TODO: Implement seek() method. |
|
|
|
|
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
/** |
119
|
|
|
* Seek to the beginning of the stream. |
120
|
|
|
* |
121
|
|
|
* If the stream is not seekable, this method will raise an exception; |
122
|
|
|
* otherwise, it will perform a seek(0). |
123
|
|
|
* |
124
|
|
|
* @see seek() |
125
|
|
|
* @link http://www.php.net/manual/en/function.fseek.php |
126
|
|
|
* @throws \RuntimeException on failure. |
127
|
|
|
*/ |
128
|
|
|
public function rewind() |
129
|
|
|
{ |
130
|
|
|
// TODO: Implement rewind() method. |
|
|
|
|
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
/** |
134
|
|
|
* Returns whether or not the stream is writable. |
135
|
|
|
* |
136
|
|
|
* @return bool |
|
|
|
|
137
|
|
|
*/ |
138
|
|
|
public function isWritable() |
139
|
|
|
{ |
140
|
|
|
// TODO: Implement isWritable() method. |
|
|
|
|
141
|
|
|
} |
142
|
|
|
|
143
|
|
|
/** |
144
|
|
|
* Write data to the stream. |
145
|
|
|
* |
146
|
|
|
* @param string $string The string that is to be written. |
147
|
|
|
* @return int Returns the number of bytes written to the stream. |
|
|
|
|
148
|
|
|
* @throws \RuntimeException on failure. |
149
|
|
|
*/ |
150
|
|
|
public function write($string) |
151
|
|
|
{ |
152
|
|
|
// TODO: Implement write() method. |
|
|
|
|
153
|
|
|
} |
154
|
|
|
|
155
|
|
|
/** |
156
|
|
|
* Returns whether or not the stream is readable. |
157
|
|
|
* |
158
|
|
|
* @return bool |
|
|
|
|
159
|
|
|
*/ |
160
|
|
|
public function isReadable() |
161
|
|
|
{ |
162
|
|
|
// TODO: Implement isReadable() method. |
|
|
|
|
163
|
|
|
} |
164
|
|
|
|
165
|
|
|
/** |
166
|
|
|
* Read data from the stream. |
167
|
|
|
* |
168
|
|
|
* @param int $length Read up to $length bytes from the object and return |
169
|
|
|
* them. Fewer than $length bytes may be returned if underlying stream |
170
|
|
|
* call returns fewer bytes. |
171
|
|
|
* @return string Returns the data read from the stream, or an empty string |
|
|
|
|
172
|
|
|
* if no bytes are available. |
173
|
|
|
* @throws \RuntimeException if an error occurs. |
174
|
|
|
*/ |
175
|
|
|
public function read($length) |
176
|
|
|
{ |
177
|
|
|
// TODO: Implement read() method. |
|
|
|
|
178
|
|
|
} |
179
|
|
|
|
180
|
|
|
/** |
181
|
|
|
* Returns the remaining contents in a string |
182
|
|
|
* |
183
|
|
|
* @return string |
|
|
|
|
184
|
|
|
* @throws \RuntimeException if unable to read or an error occurs while |
185
|
|
|
* reading. |
186
|
|
|
*/ |
187
|
|
|
public function getContents() |
188
|
|
|
{ |
189
|
|
|
// TODO: Implement getContents() method. |
|
|
|
|
190
|
|
|
} |
191
|
|
|
|
192
|
|
|
/** |
193
|
|
|
* Get stream metadata as an associative array or retrieve a specific key. |
194
|
|
|
* |
195
|
|
|
* The keys returned are identical to the keys returned from PHP's |
196
|
|
|
* stream_get_meta_data() function. |
197
|
|
|
* |
198
|
|
|
* @link http://php.net/manual/en/function.stream-get-meta-data.php |
199
|
|
|
* @param string $key Specific metadata to retrieve. |
|
|
|
|
200
|
|
|
* @return array|mixed|null Returns an associative array if no key is |
201
|
|
|
* provided. Returns a specific key value if a key is provided and the |
202
|
|
|
* value is found, or null if the key is not found. |
203
|
|
|
*/ |
204
|
|
|
public function getMetadata($key = null) |
205
|
|
|
{ |
206
|
|
|
// TODO: Implement getMetadata() method. |
|
|
|
|
207
|
|
|
} |
208
|
|
|
} |
209
|
|
|
|
This check compares the return type specified in the
@return
annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.