Stream::read() - Code Metrics - ThrusterIO/http-message - Measure and Improve Code Quality continuously with Scrutinizer

Stream::read() A
last analyzed 2016-02-11 01:19 UTC

↳ Parent: Stream

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
crap	2

<?php

namespace Thruster\Component\HttpMessage;

use Psr\Http\Message\StreamInterface;

/**
 * Class Stream
 *
 * @package Thruster\Component\HttpMessage
 * @author  Aurimas Niekis <[email protected]>
 */
class Stream implements StreamInterface
{
    /** @var array Hash of readable and writable stream types */
    const READ_WRITE_HASH = [
        'read'  => [
            'r'   => true,
            'w+'  => true,
            'r+'  => true,
            'x+'  => true,
            'c+'  => true,
            'rb'  => true,
            'w+b' => true,
            'r+b' => true,
            'x+b' => true,
            'c+b' => true,
            'rt'  => true,
            'w+t' => true,
            'r+t' => true,
            'x+t' => true,
            'c+t' => true,
            'a+'  => true
        ],
        'write' => [
            'w'   => true,
            'w+'  => true,
            'rw'  => true,
            'r+'  => true,
            'x+'  => true,
            'c+'  => true,
            'wb'  => true,
            'w+b' => true,
            'r+b' => true,
            'x+b' => true,
            'c+b' => true,
            'w+t' => true,
            'r+t' => true,
            'x+t' => true,
            'c+t' => true,
            'a'   => true,
            'a+'  => true
        ]
    ];

    /**
     * @var resource
     */
    private $stream;

    /**
     * @var int
     */
    private $size;

    /**
     * @var bool
     */
    private $seekable;

    /**
     * @var bool
     */
    private $readable;

    /**
     * @var bool
     */
    private $writable;

    /**
     * @var array|mixed|null
     */
    private $uri;

    /**
     * @var array
     */
    private $customMetadata;

    /**
     * This constructor accepts an associative array of options.
     *
     * - size: (int) If a read stream would otherwise have an indeterminate
     *   size, but the size is known due to foreknownledge, then you can
     *   provide that size, in bytes.
     * - metadata: (array) Any additional metadata to return when the metadata
     *   of the stream is accessed.
     *
     * @param resource $stream  Stream resource to wrap.
     * @param array    $options Associative array of options.
     *
     * @throws \InvalidArgumentException if the stream is not a stream resource
     */
    public function __construct($stream, $options = [])
    {
        if (false === is_resource($stream)) {
            throw new \InvalidArgumentException('Stream must be a resource');
        }

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

        $this->customMetadata = $options['metadata'] ?? [];

        $this->stream   = $stream;
        $meta           = stream_get_meta_data($this->stream);
        $this->seekable = $meta['seekable'];
        $this->readable = isset(static::READ_WRITE_HASH['read'][$meta['mode']]);
        $this->writable = isset(static::READ_WRITE_HASH['write'][$meta['mode']]);
        $this->uri = $this->getMetadata('uri');
    }

    public function __get($name)
    {
        if ('stream' == $name) {
            throw new \RuntimeException('The stream is detached');
        }

        throw new \BadMethodCallException('No value for ' . $name);
    }

    /**
     * Closes the stream when the destructed
     */
    public function __destruct()
    {
        $this->close();
    }

    public function __toString() : string
    {
        try {
            $this->seek(0);
            return (string) stream_get_contents($this->stream);
        } catch (\Exception $e) {
            return '';
        }
    }

    public function getContents() : string
    {
        $contents = stream_get_contents($this->stream);

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

        return $contents;
    }

    public function close()
    {
        if (isset($this->stream)) {
            if (is_resource($this->stream)) {
                fclose($this->stream);
            }

            $this->detach();
        }
    }

    public function detach()
    {
        if (false === isset($this->stream)) {
            return null;
        }

        $result = $this->stream;
        unset($this->stream);
        $this->size     = $this->uri = null;
        $this->readable = $this->writable = $this->seekable = false;

        return $result;
    }

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

        if (false === isset($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;
    }

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

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

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

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

    public function tell() : int
    {
        $result = ftell($this->stream);

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

        return $result;
    }

    public function rewind()
    {
        $this->seek(0);
    }

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

    public function read($length)
    {
        if (false === $this->readable) {
            throw new \RuntimeException('Cannot read from non-readable stream');
        }

        return fread($this->stream, $length);
    }

    public function write($string)
    {
        if (false === $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 (false === $result) {
            throw new \RuntimeException('Unable to write to stream');
        }

        return $result;
    }

    public function getMetadata($key = null)
    {
        if (false === isset($this->stream)) {
            return $key ? null : [];
        } elseif (null === $key) {
            return $this->customMetadata + stream_get_meta_data($this->stream);
        } elseif (isset($this->customMetadata[$key])) {
            return $this->customMetadata[$key];
        }

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

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


1		<?php
2
3		namespace Thruster\Component\HttpMessage;
4
5		use Psr\Http\Message\StreamInterface;
6
7		/**
8		* Class Stream
9		*
10		* @package Thruster\Component\HttpMessage
11		* @author Aurimas Niekis <[email protected]>
12		*/
13		class Stream implements StreamInterface
14		{
15		/** @var array Hash of readable and writable stream types */
16		const READ_WRITE_HASH = [
17		'read' => [
18		'r' => true,
19		'w+' => true,
20		'r+' => true,
21		'x+' => true,
22		'c+' => true,
23		'rb' => true,
24		'w+b' => true,
25		'r+b' => true,
26		'x+b' => true,
27		'c+b' => true,
28		'rt' => true,
29		'w+t' => true,
30		'r+t' => true,
31		'x+t' => true,
32		'c+t' => true,
33		'a+' => true
34		],
35		'write' => [
36		'w' => true,
37		'w+' => true,
38		'rw' => true,
39		'r+' => true,
40		'x+' => true,
41		'c+' => true,
42		'wb' => true,
43		'w+b' => true,
44		'r+b' => true,
45		'x+b' => true,
46		'c+b' => true,
47		'w+t' => true,
48		'r+t' => true,
49		'x+t' => true,
50		'c+t' => true,
51		'a' => true,
52		'a+' => true
53		]
54		];
55
56		/**
57		* @var resource
58		*/
59		private $stream;
60
61		/**
62		* @var int
63		*/
64		private $size;
65
66		/**
67		* @var bool
68		*/
69		private $seekable;
70
71		/**
72		* @var bool
73		*/
74		private $readable;
75
76		/**
77		* @var bool
78		*/
79		private $writable;
80
81		/**
82		* @var array\|mixed\|null
83		*/
84		private $uri;
85
86		/**
87		* @var array
88		*/
89		private $customMetadata;
90
91		/**
92		* This constructor accepts an associative array of options.
93		*
94		* - size: (int) If a read stream would otherwise have an indeterminate
95		* size, but the size is known due to foreknownledge, then you can
96		* provide that size, in bytes.
97		* - metadata: (array) Any additional metadata to return when the metadata
98		* of the stream is accessed.
99		*
100		* @param resource $stream Stream resource to wrap.
101		* @param array $options Associative array of options.
102		*
103		* @throws \InvalidArgumentException if the stream is not a stream resource
104		*/
105	92	public function __construct($stream, $options = [])
106		{
107	92	if (false === is_resource($stream)) {
108	1	throw new \InvalidArgumentException('Stream must be a resource');
109		}
110
111	91	if (isset($options['size'])) {
112		$this->size = $options['size'];
113		}
114
115	91	$this->customMetadata = $options['metadata'] ?? [];
116
117	91	$this->stream = $stream;
118	91	$meta = stream_get_meta_data($this->stream);
119	91	$this->seekable = $meta['seekable'];
120	91	$this->readable = isset(static::READ_WRITE_HASH['read'][$meta['mode']]);
121	91	$this->writable = isset(static::READ_WRITE_HASH['write'][$meta['mode']]);
122	91	$this->uri = $this->getMetadata('uri');
123	91	}
124
125	1	public function __get($name)
126		{
127	1	if ('stream' == $name) {
128	1	throw new \RuntimeException('The stream is detached');
129		}
130
131		throw new \BadMethodCallException('No value for ' . $name);
132		}
133
134		/**
135		* Closes the stream when the destructed
136		*/
137	68	public function __destruct()
138		{
139	68	$this->close();
140	68	}
141
142	8	public function __toString() : string
143		{
144		try {
145	8	$this->seek(0);
146	7	return (string) stream_get_contents($this->stream);
147	1	} catch (\Exception $e) {
148	1	return '';
149		}
150		}
151
152	4	public function getContents() : string
153		{
154	4	$contents = stream_get_contents($this->stream);
155
156	3	if ($contents === false) {
157		throw new \RuntimeException('Unable to read stream contents');
158		}
159
160	3	return $contents;
161		}
162
163	73	public function close()
164		{
165	73	if (isset($this->stream)) {
166	69	if (is_resource($this->stream)) {
167	69	fclose($this->stream);
168		}
169
170	69	$this->detach();
171		}
172	73	}
173
174	74	public function detach()
175		{
176	74	if (false === isset($this->stream)) {
177	1	return null;
178		}
179
180	74	$result = $this->stream;
181	74	unset($this->stream);
182	74	$this->size = $this->uri = null;
183	74	$this->readable = $this->writable = $this->seekable = false;
184
185	74	return $result;
186		}
187
188	26	public function getSize()
189		{
190	26	if (null !== $this->size) {
191	8	return $this->size;
192		}
193
194	26	if (false === isset($this->stream)) {
195	2	return null;
196		}
197
198		// Clear the stat cache if the stream has a URI
199	24	if ($this->uri) {
200	24	clearstatcache(true, $this->uri);
201		}
202
203	24	$stats = fstat($this->stream);
204	24	if (isset($stats['size'])) {
205	24	$this->size = $stats['size'];
206
207	24	return $this->size;
208		}
209
210		return null;
211		}
212
213	23	public function isReadable() : bool
214		{
215	23	return $this->readable;
216		}
217
218	8	public function isWritable() : bool
219		{
220	8	return $this->writable;
221		}
222
223	41	public function isSeekable() : bool
224		{
225	41	return $this->seekable;
226		}
227
228	33	public function eof() : bool
229		{
230	33	return !$this->stream \|\| feof($this->stream);
231		}
232
233	28	public function tell() : int
234		{
235	28	$result = ftell($this->stream);
236
237	27	if ($result === false) {
238		throw new \RuntimeException('Unable to determine stream position');
239		}
240
241	27	return $result;
242		}
243
244	7	public function rewind()
245		{
246	7	$this->seek(0);
247	7	}
248
249	44	public function seek($offset, $whence = SEEK_SET)
250		{
251	44	if (false === $this->seekable) {
252	1	throw new \RuntimeException('Stream is not seekable');
253	43	} elseif (-1 === fseek($this->stream, $offset, $whence)) {
254	1	throw new \RuntimeException('Unable to seek to stream position '
255	1	. $offset . ' with whence ' . var_export($whence, true));
256		}
257	43	}
258
259	38	public function read($length)
260		{
261	38	if (false === $this->readable) {
262	1	throw new \RuntimeException('Cannot read from non-readable stream');
263		}
264
265	37	return fread($this->stream, $length);
266		}
267
268	18	public function write($string)
269		{
270	18	if (false === $this->writable) {
271	2	throw new \RuntimeException('Cannot write to a non-writable stream');
272		}
273
274		// We can't know the size after writing anything
275	17	$this->size = null;
276	17	$result = fwrite($this->stream, $string);
277
278	17	if (false === $result) {
279		throw new \RuntimeException('Unable to write to stream');
280		}
281
282	17	return $result;
283		}
284
285	91	public function getMetadata($key = null)
286		{
287	91	if (false === isset($this->stream)) {
288	1	return $key ? null : [];
289	91	} elseif (null === $key) {
290	5	return $this->customMetadata + stream_get_meta_data($this->stream);
291	91	} elseif (isset($this->customMetadata[$key])) {
292		return $this->customMetadata[$key];
293		}
294
295	91	$meta = stream_get_meta_data($this->stream);
296
297	91	return isset($meta[$key]) ? $meta[$key] : null;
298		}
299		}
300

ThrusterIO / http-message

Stream::read() A last analyzed 2016-02-11 01:19 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

Stream::read() A
last analyzed 2016-02-11 01:19 UTC