Stream::detach() - Code Metrics - Inspection of "Various code optimizations (#102)" - Nyholm/psr7 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e78b35...c448e0 )

by Tobias

created 2019-02-14 20:33 UTC

Stream::detach() A

↳ Parent: Stream

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	8
cts	8
cp	1
rs	9.8333
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php

declare(strict_types=1);

namespace Nyholm\Psr7;

use Psr\Http\Message\StreamInterface;

/**
 * @author Michael Dowling and contributors to guzzlehttp/psr7
 * @author Tobias Nyholm <[email protected]>
 * @author Martijn van der Ven <[email protected]>
 */
final class Stream implements StreamInterface
{
    /** @var resource A resource reference */
    private $stream;

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

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

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

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

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

    /** @var array Hash of readable and writable stream types */
    private 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,
        ],
    ];

    private function __construct()
    {
    }

    /**
     * Creates a new PSR-7 stream.
     *
     * @param string|resource|StreamInterface $body
     *
     * @return StreamInterface
     *
     * @throws \InvalidArgumentException
     */
    public static function create($body = ''): StreamInterface
    {
        if ($body instanceof StreamInterface) {
            return $body;
        }

        if (\is_string($body)) {
            $resource = \fopen('php://temp', 'rw+');
            \fwrite($resource, $body);
            $body = $resource;
        }

        if (\is_resource($body)) {
            $new = new self();
            $new->stream = $body;
            $meta = \stream_get_meta_data($new->stream);
            $new->seekable = $meta['seekable'];
            $new->readable = isset(self::READ_WRITE_HASH['read'][$meta['mode']]);
            $new->writable = isset(self::READ_WRITE_HASH['write'][$meta['mode']]);
            $new->uri = $new->getMetadata('uri');

            return $new;
        }

        throw new \InvalidArgumentException('First argument to Stream::create() must be a string, resource or StreamInterface.');
    }

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

    public function __toString(): string
    {
        try {
            if ($this->isSeekable()) {
                $this->seek(0);
            }

            return $this->getContents();
        } catch (\Exception $e) {
            return '';
        }
    }

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

    public function detach()
    {
        if (!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(): ?int
    {
        if (null !== $this->size) {
            return $this->size;
        }

        if (!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 tell(): int
    {
        if (false === $result = \ftell($this->stream)) {
            throw new \RuntimeException('Unable to determine stream position');
        }

        return $result;
    }

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

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

    public function seek($offset, $whence = \SEEK_SET): void
    {
        if (!$this->seekable) {
            throw new \RuntimeException('Stream is not seekable');
        }

        if (\fseek($this->stream, $offset, $whence) === -1) {
            throw new \RuntimeException('Unable to seek to stream position '.$offset.' with whence '.\var_export($whence, true));
        }
    }

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

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

    public function write($string): int
    {
        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;

        if (false === $result = \fwrite($this->stream, $string)) {
            throw new \RuntimeException('Unable to write to stream');
        }

        return $result;
    }

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

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

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

    public function getContents(): string
    {
        if (!isset($this->stream)) {
            throw new \RuntimeException('Unable to read stream contents');
        }

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

        return $contents;
    }

    public function getMetadata($key = null)
    {
        if (!isset($this->stream)) {
            return $key ? null : [];
        }

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

        if (null === $key) {
            return $meta;
        }

        return $meta[$key] ?? null;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Nyholm\Psr7;
6
7		use Psr\Http\Message\StreamInterface;
8
9		/**
10		* @author Michael Dowling and contributors to guzzlehttp/psr7
11		* @author Tobias Nyholm <[email protected]>
12		* @author Martijn van der Ven <[email protected]>
13		*/
14		final class Stream implements StreamInterface
15		{
16		/** @var resource A resource reference */
17		private $stream;
18
19		/** @var bool */
20		private $seekable;
21
22		/** @var bool */
23		private $readable;
24
25		/** @var bool */
26		private $writable;
27
28		/** @var array\|mixed\|null\|void */
29		private $uri;
30
31		/** @var int */
32		private $size;
33
34		/** @var array Hash of readable and writable stream types */
35		private const READ_WRITE_HASH = [
36		'read' => [
37		'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true,
38		'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true,
39		'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true,
40		'x+t' => true, 'c+t' => true, 'a+' => true,
41		],
42		'write' => [
43		'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true,
44		'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true,
45		'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true,
46		'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true,
47		],
48		];
49
50	51	private function __construct()
51		{
52	51	}
53
54		/**
55		* Creates a new PSR-7 stream.
56		*
57		* @param string\|resource\|StreamInterface $body
58		*
59		* @return StreamInterface
60		*
61		* @throws \InvalidArgumentException
62		*/
63	51	public static function create($body = ''): StreamInterface
64		{
65	51	if ($body instanceof StreamInterface) {
66		return $body;
67		}
68
69	51	if (\is_string($body)) {
70	18	$resource = \fopen('php://temp', 'rw+');
71	18	\fwrite($resource, $body);
72	18	$body = $resource;
73		}
74
75	51	if (\is_resource($body)) {
76	51	$new = new self();
77	51	$new->stream = $body;
78	51	$meta = \stream_get_meta_data($new->stream);
79	51	$new->seekable = $meta['seekable'];
80	51	$new->readable = isset(self::READ_WRITE_HASH['read'][$meta['mode']]);
81	51	$new->writable = isset(self::READ_WRITE_HASH['write'][$meta['mode']]);
82	51	$new->uri = $new->getMetadata('uri');
83
84	51	return $new;
85		}
86
87		throw new \InvalidArgumentException('First argument to Stream::create() must be a string, resource or StreamInterface.');
88		}
89
90		/**
91		* Closes the stream when the destructed.
92		*/
93	51	public function __destruct()
94		{
95	51	$this->close();
96	51	}
97
98	12	public function __toString(): string
99		{
100		try {
101	12	if ($this->isSeekable()) {
102	11	$this->seek(0);
103		}
104
105	12	return $this->getContents();
106	1	} catch (\Exception $e) {
107	1	return '';
108		}
109		}
110
111	51	public function close(): void
112		{
113	51	if (isset($this->stream)) {
114	49	if (\is_resource($this->stream)) {
115	49	\fclose($this->stream);
116		}
117	49	$this->detach();
118		}
119	51	}
120
121	51	public function detach()
122		{
123	51	if (!isset($this->stream)) {
124	1	return null;
125		}
126
127	51	$result = $this->stream;
128	51	unset($this->stream);
129	51	$this->size = $this->uri = null;
130	51	$this->readable = $this->writable = $this->seekable = false;
131
132	51	return $result;
133		}
134
135	18	public function getSize(): ?int
136		{
137	18	if (null !== $this->size) {
138	2	return $this->size;
139		}
140
141	18	if (!isset($this->stream)) {
142	2	return null;
143		}
144
145		// Clear the stat cache if the stream has a URI
146	16	if ($this->uri) {
147	16	\clearstatcache(true, $this->uri);
148		}
149
150	16	$stats = \fstat($this->stream);
151	16	if (isset($stats['size'])) {
152	16	$this->size = $stats['size'];
153
154	16	return $this->size;
155		}
156
157		return null;
158		}
159
160	3	public function tell(): int
161		{
162	3	if (false === $result = \ftell($this->stream)) {
163		throw new \RuntimeException('Unable to determine stream position');
164		}
165
166	2	return $result;
167		}
168
169	8	public function eof(): bool
170		{
171	8	return !$this->stream \|\| \feof($this->stream);
172		}
173
174	20	public function isSeekable(): bool
175		{
176	20	return $this->seekable;
177		}
178
179	25	public function seek($offset, $whence = \SEEK_SET): void
180		{
181	25	if (!$this->seekable) {
182	2	throw new \RuntimeException('Stream is not seekable');
183	23	}
184
185		if (\fseek($this->stream, $offset, $whence) === -1) {
186	23	throw new \RuntimeException('Unable to seek to stream position '.$offset.' with whence '.\var_export($whence, true));
187		}
188	8	}
189
190	8	public function rewind(): void
191	7	{
192		$this->seek(0);
193	5	}
194
195	5	public function isWritable(): bool
196		{
197		return $this->writable;
198	9	}
199
200	9	public function write($string): int
201	2	{
202		if (!$this->writable) {
203		throw new \RuntimeException('Cannot write to a non-writable stream');
204		}
205	8
206		// We can't know the size after writing anything
207	8	$this->size = null;
208
209		if (false === $result = \fwrite($this->stream, $string)) {
210		throw new \RuntimeException('Unable to write to stream');
211	8	}
212
213		return $result;
214	5	}
215
216	5	public function isReadable(): bool
217		{
218		return $this->readable;
219	9	}
220
221	9	public function read($length): string
222	2	{
223		if (!$this->readable) {
224		throw new \RuntimeException('Cannot read from non-readable stream');
225	7	}
226
227		return \fread($this->stream, $length);
228	14	}
229
230	14	public function getContents(): string
231	1	{
232		if (!isset($this->stream)) {
233		throw new \RuntimeException('Unable to read stream contents');
234	13	}
235
236		if (false === $contents = \stream_get_contents($this->stream)) {
237		throw new \RuntimeException('Unable to read stream contents');
238	13	}
239
240		return $contents;
241	51	}
242
243	51	public function getMetadata($key = null)
244	1	{
245	51	if (!isset($this->stream)) {
246	1	return $key ? null : [];
247		}
248
249	51	$meta = \stream_get_meta_data($this->stream);
250
251	51	if (null === $key) {
252		return $meta;
253		}
254
255		return $meta[$key] ?? null;
256		}
257		}
258

Nyholm / psr7

Push — master ( e78b35...c448e0 )

Stream::detach() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like