Stream::__construct() - Code Metrics - Inspection of "Deploying to gh-pages from @ dad899eb2821908b9bda..." - chillerlan/php-httpinterface - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — gh-pages ( 22b0fe...eb2d91 )

unknown

created 2021-03-12 20:08 UTC

Stream::__construct() A

↳ Parent: Stream

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	14
rs	10

<?php
/**
 * Class Stream
 *
 * @created      11.08.2018
 * @author       smiley <[email protected]>
 * @copyright    2018 smiley
 * @license      MIT
 */

namespace chillerlan\HTTP\Psr7;

use Exception, InvalidArgumentException, RuntimeException;

use function clearstatcache, fclose, feof, fread, fstat, ftell, fwrite, is_resource, stream_get_contents, stream_get_meta_data;

use const SEEK_SET;
use const chillerlan\HTTP\Psr17\{STREAM_MODES_READ, STREAM_MODES_WRITE};
filter:
    dependency_paths: ["lib/*"]

/**
 * @property resource|null $stream
 */
final class Stream extends StreamAbstract{

	private bool $seekable;

	private bool $readable;

	private bool $writable;

	private ?string $uri = null;

	private ?int $size = null;

	/**
	 * Stream constructor.
	 *
	 * @param resource $stream
	 */
	public function __construct($stream){

		if(!is_resource($stream)){
			throw new InvalidArgumentException('Stream must be a resource');
		}

		$this->stream = $stream;

		$meta = stream_get_meta_data($this->stream);

		$this->seekable = $meta['seekable'];
		$this->readable = isset(STREAM_MODES_READ[$meta['mode']]);
		$this->writable = isset(STREAM_MODES_WRITE[$meta['mode']]);
		$this->uri      = $meta['uri'] ?? null;
	}

	/**
	 * @inheritDoc
	 */
	public function __toString(){

		if(!is_resource($this->stream)){
			return '';
		}

		try{

			if($this->isSeekable()){
				$this->seek(0);
			}

			return (string)stream_get_contents($this->stream);
		}
		// @codeCoverageIgnoreStart
		catch(Exception $e){
			throw new RuntimeException('Stream::__toString exception: '.$e->getMessage());
		}
		// @codeCoverageIgnoreEnd

	}

	/**
	 * @inheritDoc
	 */
	public function close():void{

		if(is_resource($this->stream)){
			fclose($this->stream);
		}

		$this->detach();
	}

	/**
	 * @inheritDoc
	 */
	public function detach(){
		$oldResource = $this->stream;

		$this->stream   = null;
		$this->size     = null;
		$this->uri      = null;
		$this->readable = false;
		$this->writable = false;
		$this->seekable = false;

		return $oldResource;
	}

	/**
	 * @inheritDoc
	 */
	public function getSize():?int{

		if($this->size !== null){
			return $this->size;
		}

		if(!is_resource($this->stream)){
			return null;
		}

		// Clear the stat cache if the stream has a URI
		if($this->uri){
			clearstatcache(true, $this->uri);
		}

		$stats = fstat($this->stream);

		if(isset($stats['size'])){
			$this->size = $stats['size'];

			return $this->size;
		}

		return null; // @codeCoverageIgnore
	}

	/**
	 * @inheritDoc
	 */
	public function tell():int{

		if(!is_resource($this->stream)){
			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
		}

		$result = ftell($this->stream);

		if($result === false){
			throw new RuntimeException('Unable to determine stream position'); // @codeCoverageIgnore
		}

		return $result;
	}

	/**
	 * @inheritDoc
	 */
	public function eof():bool{
		return !$this->stream || feof($this->stream);
	}

	/**
	 * @inheritDoc
	 */
	public function isSeekable():bool{
		return $this->seekable;
	}

	/**
	 * @inheritDoc
	 */
	public function seek($offset, $whence = SEEK_SET):void{

		if(!is_resource($this->stream)){
			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
		}

		if(!$this->seekable){
			throw new RuntimeException('Stream is not seekable');
		}
		elseif(fseek($this->stream, $offset, $whence) === -1){
			throw new RuntimeException('Unable to seek to stream position '.$offset.' with whence '.$whence);
		}

	}

	/**
	 * @inheritDoc
	 */
	public function rewind():void{
		$this->seek(0);
	}

	/**
	 * @inheritDoc
	 */
	public function isWritable():bool{
		return $this->writable;
	}

	/**
	 * @inheritDoc
	 */
	public function write($string):int{

		if(!is_resource($this->stream)){
			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
		}

		if(!$this->writable){
			throw new RuntimeException('Cannot write to a non-writable stream');
		}

		// We can't know the size after writing anything
		$this->size = null;
		$result     = fwrite($this->stream, $string);

		if($result === false){
			throw new RuntimeException('Unable to write to stream'); // @codeCoverageIgnore
		}

		return $result;
	}

	/**
	 * @inheritDoc
	 */
	public function isReadable():bool{
		return $this->readable;
	}

	/**
	 * @inheritDoc
	 */
	public function read($length):string{

		if(!is_resource($this->stream)){
			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
		}

		if(!$this->readable){
			throw new RuntimeException('Cannot read from non-readable stream');
		}

		if($length < 0){
			throw new RuntimeException('Length parameter cannot be negative');
		}

		if($length === 0){
			return '';
		}

		$string = fread($this->stream, $length);

		if($string === false){
			throw new RuntimeException('Unable to read from stream'); // @codeCoverageIgnore
		}

		return $string;
	}

	/**
	 * @inheritDoc
	 */
	public function getContents():string{

		if(!is_resource($this->stream)){
			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
		}

		$contents = stream_get_contents($this->stream);

		if($contents === false){
			throw new RuntimeException('Unable to read stream contents'); // @codeCoverageIgnore
		}

		return $contents;
	}

	/**
	 * @inheritDoc
	 */
	public function getMetadata($key = null){

		if(!is_resource($this->stream)){
			return $key ? null : [];
		}
		elseif($key === null){
			return stream_get_meta_data($this->stream);
		}

		$meta = stream_get_meta_data($this->stream);

		return isset($meta[$key]) ? $meta[$key] : null;
	}

}


1			<?php
2			/**
3			* Class Stream
4			*
5			* @created 11.08.2018
6			* @author smiley <[email protected]>
7			* @copyright 2018 smiley
8			* @license MIT
9			*/
10
11			namespace chillerlan\HTTP\Psr7;
12
13			use Exception, InvalidArgumentException, RuntimeException;
14
15			use function clearstatcache, fclose, feof, fread, fstat, ftell, fwrite, is_resource, stream_get_contents, stream_get_meta_data;
16
17			use const SEEK_SET;
18			use const chillerlan\HTTP\Psr17\{STREAM_MODES_READ, STREAM_MODES_WRITE};
			0 ignored issues – show Bug introduced 2021-01-10 16:25 UTC by Report Bug Copy Issue Report The type `chillerlan\HTTP\Psr17\STREAM_MODES_READ` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2021-01-10 16:25 UTC by Report Bug Copy Issue Report The type `chillerlan\HTTP\Psr17\STREAM_MODES_WRITE` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19
20			/**
21			* @property resource\|null $stream
22			*/
23			final class Stream extends StreamAbstract{
24
25			private bool $seekable;
26
27			private bool $readable;
28
29			private bool $writable;
30
31			private ?string $uri = null;
32
33			private ?int $size = null;
34
35			/**
36			* Stream constructor.
37			*
38			* @param resource $stream
39			*/
40			public function __construct($stream){
41
42			if(!is_resource($stream)){
43			throw new InvalidArgumentException('Stream must be a resource');
44			}
45
46			$this->stream = $stream;
47
48			$meta = stream_get_meta_data($this->stream);
49
50			$this->seekable = $meta['seekable'];
51			$this->readable = isset(STREAM_MODES_READ[$meta['mode']]);
52			$this->writable = isset(STREAM_MODES_WRITE[$meta['mode']]);
53			$this->uri = $meta['uri'] ?? null;
54			}
55
56			/**
57			* @inheritDoc
58			*/
59			public function __toString(){
60
61			if(!is_resource($this->stream)){
62			return '';
63			}
64
65			try{
66
67			if($this->isSeekable()){
68			$this->seek(0);
69			}
70
71			return (string)stream_get_contents($this->stream);
72			}
73			// @codeCoverageIgnoreStart
74			catch(Exception $e){
75			throw new RuntimeException('Stream::__toString exception: '.$e->getMessage());
76			}
77			// @codeCoverageIgnoreEnd
78
79			}
80
81			/**
82			* @inheritDoc
83			*/
84			public function close():void{
85
86			if(is_resource($this->stream)){
87			fclose($this->stream);
88			}
89
90			$this->detach();
91			}
92
93			/**
94			* @inheritDoc
95			*/
96			public function detach(){
97			$oldResource = $this->stream;
98
99			$this->stream = null;
100			$this->size = null;
101			$this->uri = null;
102			$this->readable = false;
103			$this->writable = false;
104			$this->seekable = false;
105
106			return $oldResource;
107			}
108
109			/**
110			* @inheritDoc
111			*/
112			public function getSize():?int{
113
114			if($this->size !== null){
115			return $this->size;
116			}
117
118			if(!is_resource($this->stream)){
119			return null;
120			}
121
122			// Clear the stat cache if the stream has a URI
123			if($this->uri){
124			clearstatcache(true, $this->uri);
125			}
126
127			$stats = fstat($this->stream);
128
129			if(isset($stats['size'])){
130			$this->size = $stats['size'];
131
132			return $this->size;
133			}
134
135			return null; // @codeCoverageIgnore
136			}
137
138			/**
139			* @inheritDoc
140			*/
141			public function tell():int{
142
143			if(!is_resource($this->stream)){
144			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
145			}
146
147			$result = ftell($this->stream);
148
149			if($result === false){
150			throw new RuntimeException('Unable to determine stream position'); // @codeCoverageIgnore
151			}
152
153			return $result;
154			}
155
156			/**
157			* @inheritDoc
158			*/
159			public function eof():bool{
160			return !$this->stream \|\| feof($this->stream);
161			}
162
163			/**
164			* @inheritDoc
165			*/
166			public function isSeekable():bool{
167			return $this->seekable;
168			}
169
170			/**
171			* @inheritDoc
172			*/
173			public function seek($offset, $whence = SEEK_SET):void{
174
175			if(!is_resource($this->stream)){
176			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
177			}
178
179			if(!$this->seekable){
180			throw new RuntimeException('Stream is not seekable');
181			}
182			elseif(fseek($this->stream, $offset, $whence) === -1){
183			throw new RuntimeException('Unable to seek to stream position '.$offset.' with whence '.$whence);
184			}
185
186			}
187
188			/**
189			* @inheritDoc
190			*/
191			public function rewind():void{
192			$this->seek(0);
193			}
194
195			/**
196			* @inheritDoc
197			*/
198			public function isWritable():bool{
199			return $this->writable;
200			}
201
202			/**
203			* @inheritDoc
204			*/
205			public function write($string):int{
206
207			if(!is_resource($this->stream)){
208			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
209			}
210
211			if(!$this->writable){
212			throw new RuntimeException('Cannot write to a non-writable stream');
213			}
214
215			// We can't know the size after writing anything
216			$this->size = null;
217			$result = fwrite($this->stream, $string);
218
219			if($result === false){
220			throw new RuntimeException('Unable to write to stream'); // @codeCoverageIgnore
221			}
222
223			return $result;
224			}
225
226			/**
227			* @inheritDoc
228			*/
229			public function isReadable():bool{
230			return $this->readable;
231			}
232
233			/**
234			* @inheritDoc
235			*/
236			public function read($length):string{
237
238			if(!is_resource($this->stream)){
239			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
240			}
241
242			if(!$this->readable){
243			throw new RuntimeException('Cannot read from non-readable stream');
244			}
245
246			if($length < 0){
247			throw new RuntimeException('Length parameter cannot be negative');
248			}
249
250			if($length === 0){
251			return '';
252			}
253
254			$string = fread($this->stream, $length);
255
256			if($string === false){
257			throw new RuntimeException('Unable to read from stream'); // @codeCoverageIgnore
258			}
259
260			return $string;
261			}
262
263			/**
264			* @inheritDoc
265			*/
266			public function getContents():string{
267
268			if(!is_resource($this->stream)){
269			throw new RuntimeException('Invalid stream'); // @codeCoverageIgnore
270			}
271
272			$contents = stream_get_contents($this->stream);
273
274			if($contents === false){
275			throw new RuntimeException('Unable to read stream contents'); // @codeCoverageIgnore
276			}
277
278			return $contents;
279			}
280
281			/**
282			* @inheritDoc
283			*/
284			public function getMetadata($key = null){
285
286			if(!is_resource($this->stream)){
287			return $key ? null : [];
288			}
289			elseif($key === null){
290			return stream_get_meta_data($this->stream);
291			}
292
293			$meta = stream_get_meta_data($this->stream);
294
295			return isset($meta[$key]) ? $meta[$key] : null;
296			}
297
298			}
299

chillerlan / php-httpinterface

Push — gh-pages ( 22b0fe...eb2d91 )

Stream::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like