Debian Codegraph @

vendor/guzzlehttp/psr7/src/BufferStream.php

raw
1 <?php
2
3 declare(strict_types=1);
4
5 namespace GuzzleHttp\Psr7;
6
7 use Psr\Http\Message\StreamInterface;
8
9 /**
10 * Provides a buffer stream that can be written to to fill a buffer, and read
11 * from to remove bytes from the buffer.
12 *
13 * This stream returns a "hwm" metadata value that tells upstream consumers
14 * what the configured high water mark of the stream is, or the maximum
15 * preferred size of the buffer.
16 */
17 final class BufferStream implements StreamInterface
18 {
19 /** @var int */
20 private $hwm;
21
22 /** @var string */
23 private $buffer = '';
24
25 /**
26 * @param int $hwm High water mark, representing the preferred maximum
27 * buffer size. If the size of the buffer exceeds the high
28 * water mark, then calls to write will continue to succeed
29 * but will return 0 to inform writers to slow down
30 * until the buffer has been drained by reading from it.
31 */
32 public function __construct(int $hwm = 16384)
33 {
34 $this->hwm = $hwm;
35 }
36
37 public function __toString(): string
38 {
39 return $this->getContents();
40 }
41
42 public function getContents(): string
43 {
44 $buffer = $this->buffer;
45 $this->buffer = '';
46
47 return $buffer;
48 }
49
50 public function close(): void
51 {
52 $this->buffer = '';
53 }
54
55 public function detach()
56 {
57 $this->close();
58
59 return null;
60 }
61
62 public function getSize(): ?int
63 {
64 return strlen($this->buffer);
65 }
66
67 public function isReadable(): bool
68 {
69 return true;
70 }
71
72 public function isWritable(): bool
73 {
74 return true;
75 }
76
77 public function isSeekable(): bool
78 {
79 return false;
80 }
81
82 public function rewind(): void
83 {
84 $this->seek(0);
85 }
86
87 public function seek($offset, $whence = SEEK_SET): void
88 {
89 if (!\is_int($offset)) {
90 \trigger_deprecation(
91 'guzzlehttp/psr7',
92 '2.11',
93 'Passing %s to StreamInterface::seek() is deprecated; guzzlehttp/psr7 3.0 requires int for $offset.',
94 \get_debug_type($offset)
95 );
96 }
97
98 if (!\is_int($whence)) {
99 \trigger_deprecation(
100 'guzzlehttp/psr7',
101 '2.11',
102 'Passing %s to StreamInterface::seek() is deprecated; guzzlehttp/psr7 3.0 requires int for $whence.',
103 \get_debug_type($whence)
104 );
105 }
106
107 throw new \RuntimeException('Cannot seek a BufferStream');
108 }
109
110 public function eof(): bool
111 {
112 return strlen($this->buffer) === 0;
113 }
114
115 public function tell(): int
116 {
117 throw new \RuntimeException('Cannot determine the position of a BufferStream');
118 }
119
120 /**
121 * Reads data from the buffer.
122 */
123 public function read($length): string
124 {
125 if (!\is_int($length)) {
126 \trigger_deprecation(
127 'guzzlehttp/psr7',
128 '2.11',
129 'Passing %s to StreamInterface::read() is deprecated; guzzlehttp/psr7 3.0 requires int for $length.',
130 \get_debug_type($length)
131 );
132 }
133
134 $currentLength = strlen($this->buffer);
135
136 if ($length >= $currentLength) {
137 // No need to slice the buffer because we don't have enough data.
138 $result = $this->buffer;
139 $this->buffer = '';
140 } else {
141 // Slice up the result to provide a subset of the buffer.
142 $result = substr($this->buffer, 0, $length);
143 $this->buffer = substr($this->buffer, $length);
144 }
145
146 return $result;
147 }
148
149 /**
150 * Writes data to the buffer.
151 */
152 public function write($string): int
153 {
154 if (!\is_string($string)) {
155 \trigger_deprecation(
156 'guzzlehttp/psr7',
157 '2.11',
158 'Passing %s to StreamInterface::write() is deprecated; guzzlehttp/psr7 3.0 requires string for $string.',
159 \get_debug_type($string)
160 );
161 }
162
163 $this->buffer .= $string;
164
165 if (strlen($this->buffer) >= $this->hwm) {
166 return 0;
167 }
168
169 return strlen($string);
170 }
171
172 /**
173 * @return mixed
174 */
175 public function getMetadata($key = null)
176 {
177 if ($key !== null && !\is_string($key)) {
178 \trigger_deprecation(
179 'guzzlehttp/psr7',
180 '2.11',
181 'Passing %s to StreamInterface::getMetadata() is deprecated; guzzlehttp/psr7 3.0 requires string|null for $key.',
182 \get_debug_type($key)
183 );
184 }
185
186 if ($key === 'hwm') {
187 return $this->hwm;
188 }
189
190 return $key ? null : [];
191 }
192 }