Stream::detach() - Code Metrics - kambo-1st/HttpMessage - Measure and Improve Code Quality continuously with Scrutinizer

Stream::detach() A
last analyzed 2018-01-24 22:49 UTC

↳ Parent: Stream

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0
crap	1

<?php
namespace Kambo\Http\Message;

// \Spl
use RuntimeException;

// \Psr
use Psr\Http\Message\StreamInterface;

/**
 * Describes a data stream.
 *
 * It provides a wrapper around the most common operations, including serialization of
 * the entire stream to a string.
 *
 * @package Kambo\Http\Message
 * @author  Bohuslav Simek <[email protected]>
 * @license MIT
 */
class Stream implements StreamInterface
{
    /**
     * Underline stream
     *
     * @var Resource|null
     */
    private $stream = null;

    /**
     * Size of file
     *
     * @var int|null
     */
    private $size = null;

    /**
     * Metadata of file
     *
     * @var array|null
     */
    private $meta = null;

    /**
     * Resource modes
     *
     * @var  array
     * @link http://php.net/manual/function.fopen.php
     */
    private $modes = [
        'readable' => ['r', 'r+', 'w+', 'a+', 'x+', 'c+', 'w+b', 'rb', 'r+b'],
        'writable' => ['r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+', 'w+b'],
    ];

    /**
     * Constructor
     *
     * @param Resource $stream Underline resource stream
     */
    public function __construct($stream)
    {
        $this->stream = $stream;
    }

    /**
     * Closes the stream and any underlying resources.
     *
     * @return void
     */
    public function close()
    {
        if ($this->stream !== null) {
            fclose($this->stream);
        }

        $this->detach();
    }

    /**
     * Separates any underlying resources from the stream.
     *
     * After the stream has been detached, the stream is in an unusable state.
     *
     * @return resource|null Underlying PHP stream, if any
     */
    public function detach()
    {
        $oldStream = $this->stream;

        $this->stream = null;
        $this->size   = null;
        $this->meta   = null;

        return $oldStream;
    }

    /**
     * Get the size of the stream if known.
     *
     * @return int|null Returns the size in bytes if known, or null if unknown.
     */
    public function getSize()
    {
        if ($this->stream !== null && $this->size === null) {
            $stats = fstat($this->stream);
            $this->size = isset($stats['size']) ? $stats['size'] : null;
        }

        return $this->size;
    }

    /**
     * Returns the current position of the file read/write pointer
     *
     * @return int Position of the file pointer
     *
     * @throws \RuntimeException on error.
     */
    public function tell()
    {
        if ($this->stream === null || ($position = ftell($this->stream)) === false) {
            throw new RuntimeException('Could not get the position of the pointer in stream');
        }

        return $position;
    }

    /**
     * Returns true if the stream is at the end of the stream.
     *
     * @return bool
     */
    public function eof()
    {
        return $this->stream !== null ? feof($this->stream) : true;
    }

    /**
     * Returns whether or not the stream is seekable.
     *
     * @return bool 
     */
    public function isSeekable()
    {
        return $this->getMetadata('seekable');
    }

    /**
     * Seek to a position in the stream.
     *
     * @link http://www.php.net/manual/en/function.fseek.php
     *
     * @param int $offset Stream offset
     * @param int $whence Specifies how the cursor position will be calculated
     *                    based on the seek offset. Valid values are identical to the built-in
     *                    PHP $whence values for `fseek()`.  SEEK_SET: Set position equal to
     *                    offset bytes SEEK_CUR: Set position to current location plus offset
     *                    SEEK_END: Set position to end-of-stream plus offset.
     *
     * @throws \RuntimeException on failure.
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        if (!$this->isSeekable() || fseek($this->stream, $offset, $whence) === -1) {
            throw new RuntimeException('Could not seek in stream');
        }
    }

    /**
     * Seek to the beginning of the stream.
     *
     * If the stream is not seekable, this method will raise an exception;
     * otherwise, it will perform a seek(0).
     *
     * @see seek()
     * @link http://www.php.net/manual/en/function.fseek.php
     *
     * @throws \RuntimeException on failure.
     */
    public function rewind()
    {
        $this->seek(0);
    }

    /**
     * Returns whether or not the stream is writable.
     *
     * @return bool
     */
    public function isWritable()
    {
        $fileMode = $this->getMetadata('mode');
        return (in_array($fileMode, $this->modes['writable']));
    }

    /**
     * Write data to the stream.
     *
     * @param string $string The string that is to be written.
     *
     * @return int Returns the number of bytes written to the stream.
     *
     * @throws \RuntimeException on failure.
     */
    public function write($string)
    {
        if (!$this->isWritable() || ($written = fwrite($this->stream, $string)) === false) {
            throw new RuntimeException('Could not write to stream');
        }

        // clear size
        $this->size = null;

        return $written;
    }

    /**
     * Returns whether or not the stream is readable.
     *
     * @return bool
     */
    public function isReadable()
    {
        $fileMode = $this->getMetadata('mode');
        return (in_array($fileMode, $this->modes['readable']));
    }

    /**
     * Read data from the stream.
     *
     * @param int $length Read up to $length bytes from the object and return
     *                    them. Fewer than $length bytes may be returned if underlying stream
     *                    call returns fewer bytes.
     *
     * @return string Returns the data read from the stream, or an empty string
     *                if no bytes are available.
     *
     * @throws \RuntimeException if an error occurs.
     */
    public function read($length)
    {
        if (!$this->isReadable() || ($data = fread($this->stream, $length)) === false) {
            throw new RuntimeException('Could not read from stream');
        }

        return $data;
    }

    /**
     * Returns the remaining contents in a string
     *
     * @return string
     *
     * @throws \RuntimeException if unable to read or an error occurs while reading.
     */
    public function getContents()
    {
        if (!$this->isReadable() || ($contents = stream_get_contents($this->stream)) === false) {
            throw new RuntimeException('Could not get contents of stream');
        }

        return $contents;
    }

    /**
     * Get stream metadata as an associative array or retrieve a specific key.
     *
     * The keys returned are identical to the keys returned from PHP's
     * stream_get_meta_data() function.
     *
     * @link http://php.net/manual/en/function.stream-get-meta-data.php
     *
     * @param string $key Specific metadata to retrieve.
     *
     * @return array|mixed|null Returns an associative array if no key is provided.
     *                          Returns a specific key value if a key is provided and the
     *                          value is found, or null if the key is not found.
     */
    public function getMetadata($key = null)
    {
        if (isset($this->stream)) {
            $this->meta = stream_get_meta_data($this->stream);
            if (is_null($key) === true) {
                return $this->meta;
            }
        }

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

    /**
     * Reads all data from the stream into a string, from the beginning to end.
     *
     * This method attempt to seek to the beginning of the stream before
     * reading data and read the stream until the end is reached.
     *
     * Warning: This could attempt to load a large amount of data into memory.
     *
     * This method does not raise an exception in order to conform with PHP's
     * string casting operations.
     *
     * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
     *
     * @return string
     */
    public function __toString()
    {
        if ($this->stream === null) {
            return '';
        }

        try {
            $this->rewind();
            return $this->getContents();
        } catch (RuntimeException $e) {
            return '';
        }
    }
}


1		<?php
2		namespace Kambo\Http\Message;
3
4		// \Spl
5		use RuntimeException;
6
7		// \Psr
8		use Psr\Http\Message\StreamInterface;
9
10		/**
11		* Describes a data stream.
12		*
13		* It provides a wrapper around the most common operations, including serialization of
14		* the entire stream to a string.
15		*
16		* @package Kambo\Http\Message
17		* @author Bohuslav Simek <[email protected]>
18		* @license MIT
19		*/
20		class Stream implements StreamInterface
21		{
22		/**
23		* Underline stream
24		*
25		* @var Resource\|null
26		*/
27		private $stream = null;
28
29		/**
30		* Size of file
31		*
32		* @var int\|null
33		*/
34		private $size = null;
35
36		/**
37		* Metadata of file
38		*
39		* @var array\|null
40		*/
41		private $meta = null;
42
43		/**
44		* Resource modes
45		*
46		* @var array
47		* @link http://php.net/manual/function.fopen.php
48		*/
49		private $modes = [
50		'readable' => ['r', 'r+', 'w+', 'a+', 'x+', 'c+', 'w+b', 'rb', 'r+b'],
51		'writable' => ['r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+', 'w+b'],
52		];
53
54		/**
55		* Constructor
56		*
57		* @param Resource $stream Underline resource stream
58		*/
59	56	public function __construct($stream)
60		{
61	56	$this->stream = $stream;
62	56	}
63
64		/**
65		* Closes the stream and any underlying resources.
66		*
67		* @return void
68		*/
69	1	public function close()
70		{
71	1	if ($this->stream !== null) {
72	1	fclose($this->stream);
73	1	}
74
75	1	$this->detach();
76	1	}
77
78		/**
79		* Separates any underlying resources from the stream.
80		*
81		* After the stream has been detached, the stream is in an unusable state.
82		*
83		* @return resource\|null Underlying PHP stream, if any
84		*/
85	7	public function detach()
86		{
87	7	$oldStream = $this->stream;
88
89	7	$this->stream = null;
90	7	$this->size = null;
91	7	$this->meta = null;
92
93	7	return $oldStream;
94		}
95
96		/**
97		* Get the size of the stream if known.
98		*
99		* @return int\|null Returns the size in bytes if known, or null if unknown.
100		*/
101	1	public function getSize()
102		{
103	1	if ($this->stream !== null && $this->size === null) {
104	1	$stats = fstat($this->stream);
105	1	$this->size = isset($stats['size']) ? $stats['size'] : null;
106	1	}
107
108	1	return $this->size;
109		}
110
111		/**
112		* Returns the current position of the file read/write pointer
113		*
114		* @return int Position of the file pointer
115		*
116		* @throws \RuntimeException on error.
117		*/
118	2	public function tell()
119		{
120	2	if ($this->stream === null \|\| ($position = ftell($this->stream)) === false) {
121	1	throw new RuntimeException('Could not get the position of the pointer in stream');
122		}
123
124	1	return $position;
125		}
126
127		/**
128		* Returns true if the stream is at the end of the stream.
129		*
130		* @return bool
131		*/
132	2	public function eof()
133		{
134	2	return $this->stream !== null ? feof($this->stream) : true;
135		}
136
137		/**
138		* Returns whether or not the stream is seekable.
139		*
140		* @return bool
141		*/
142	8	public function isSeekable()
143		{
144	8	return $this->getMetadata('seekable');
145		}
146
147		/**
148		* Seek to a position in the stream.
149		*
150		* @link http://www.php.net/manual/en/function.fseek.php
151		*
152		* @param int $offset Stream offset
153		* @param int $whence Specifies how the cursor position will be calculated
154		* based on the seek offset. Valid values are identical to the built-in
155		* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
156		* offset bytes SEEK_CUR: Set position to current location plus offset
157		* SEEK_END: Set position to end-of-stream plus offset.
158		*
159		* @throws \RuntimeException on failure.
160		*/
161	8	public function seek($offset, $whence = SEEK_SET)
162		{
163	8	if (!$this->isSeekable() \|\| fseek($this->stream, $offset, $whence) === -1) {
164	1	throw new RuntimeException('Could not seek in stream');
165		}
166	7	}
167
168		/**
169		* Seek to the beginning of the stream.
170		*
171		* If the stream is not seekable, this method will raise an exception;
172		* otherwise, it will perform a seek(0).
173		*
174		* @see seek()
175		* @link http://www.php.net/manual/en/function.fseek.php
176		*
177		* @throws \RuntimeException on failure.
178		*/
179	5	public function rewind()
180		{
181	5	$this->seek(0);
182	5	}
183
184		/**
185		* Returns whether or not the stream is writable.
186		*
187		* @return bool
188		*/
189	4	public function isWritable()
190		{
191	4	$fileMode = $this->getMetadata('mode');
192	4	return (in_array($fileMode, $this->modes['writable']));
193		}
194
195		/**
196		* Write data to the stream.
197		*
198		* @param string $string The string that is to be written.
199		*
200		* @return int Returns the number of bytes written to the stream.
201		*
202		* @throws \RuntimeException on failure.
203		*/
204	4	public function write($string)
205		{
206	4	if (!$this->isWritable() \|\| ($written = fwrite($this->stream, $string)) === false) {
207	1	throw new RuntimeException('Could not write to stream');
208		}
209
210		// clear size
211	3	$this->size = null;
212
213	3	return $written;
214		}
215
216		/**
217		* Returns whether or not the stream is readable.
218		*
219		* @return bool
220		*/
221	10	public function isReadable()
222		{
223	10	$fileMode = $this->getMetadata('mode');
224	10	return (in_array($fileMode, $this->modes['readable']));
225		}
226
227		/**
228		* Read data from the stream.
229		*
230		* @param int $length Read up to $length bytes from the object and return
231		* them. Fewer than $length bytes may be returned if underlying stream
232		* call returns fewer bytes.
233		*
234		* @return string Returns the data read from the stream, or an empty string
235		* if no bytes are available.
236		*
237		* @throws \RuntimeException if an error occurs.
238		*/
239	2	public function read($length)
240		{
241	2	if (!$this->isReadable() \|\| ($data = fread($this->stream, $length)) === false) {
242	1	throw new RuntimeException('Could not read from stream');
243		}
244
245	1	return $data;
246		}
247
248		/**
249		* Returns the remaining contents in a string
250		*
251		* @return string
252		*
253		* @throws \RuntimeException if unable to read or an error occurs while reading.
254		*/
255	8	public function getContents()
256		{
257	8	if (!$this->isReadable() \|\| ($contents = stream_get_contents($this->stream)) === false) {
258	2	throw new RuntimeException('Could not get contents of stream');
259		}
260
261	6	return $contents;
262		}
263
264		/**
265		* Get stream metadata as an associative array or retrieve a specific key.
266		*
267		* The keys returned are identical to the keys returned from PHP's
268		* stream_get_meta_data() function.
269		*
270		* @link http://php.net/manual/en/function.stream-get-meta-data.php
271		*
272		* @param string $key Specific metadata to retrieve.
273		*
274		* @return array\|mixed\|null Returns an associative array if no key is provided.
275		* Returns a specific key value if a key is provided and the
276		* value is found, or null if the key is not found.
277		*/
278	17	public function getMetadata($key = null)
279		{
280	17	if (isset($this->stream)) {
281	14	$this->meta = stream_get_meta_data($this->stream);
282	14	if (is_null($key) === true) {
283	1	return $this->meta;
284		}
285	13	}
286
287	16	return isset($this->meta[$key]) ? $this->meta[$key] : null;
288		}
289
290		/**
291		* Reads all data from the stream into a string, from the beginning to end.
292		*
293		* This method attempt to seek to the beginning of the stream before
294		* reading data and read the stream until the end is reached.
295		*
296		* Warning: This could attempt to load a large amount of data into memory.
297		*
298		* This method does not raise an exception in order to conform with PHP's
299		* string casting operations.
300		*
301		* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
302		*
303		* @return string
304		*/
305	4	public function __toString()
306		{
307	4	if ($this->stream === null) {
308	1	return '';
309		}
310
311		try {
312	3	$this->rewind();
313	3	return $this->getContents();
314	1	} catch (RuntimeException $e) {
315	1	return '';
316		}
317		}
318		}
319

kambo-1st / HttpMessage

Stream::detach() A last analyzed 2018-01-24 22:49 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Stream::detach() A
last analyzed 2018-01-24 22:49 UTC