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

StreamDecoratorTrait::getContents() A
last analyzed 2016-02-11 01:19 UTC

↳ Parent: StreamDecoratorTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

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

<?php

namespace Thruster\Component\HttpMessage;

use Psr\Http\Message\StreamInterface;
use function Thruster\Component\HttpMessage\copy_to_string;

/**
 * Trait StreamDecoratorTrait
 *
 * @package Thruster\Component\HttpMessage
 * @author  Aurimas Niekis <[email protected]>
 */
trait StreamDecoratorTrait
{
    /**
     * @param StreamInterface $stream Stream to decorate
     */
    public function __construct(StreamInterface $stream)
    {
        $this->stream = $stream;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Magic method used to create a new stream if streams are not added in
     * the constructor of a decorator (e.g., LazyOpenStream).
     *
     * @param string $name Name of the property (allows "stream" only).
     *
     * @return StreamInterface
     */
    public function __get($name)
    {
        if ('stream' == $name) {
            $this->stream = $this->createStream();

            return $this->stream;
        }

        throw new \UnexpectedValueException("$name not found on class");
    }

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

            return $this->getContents();
        } catch (\Exception $e) {
            // Really, PHP? https://bugs.php.net/bug.php?id=53648

            trigger_error('StreamDecorator::__toString exception: '
                . (string) $e, E_USER_ERROR);
            return '';
        }
    }

    public function getContents()
    {
        return copy_to_string($this);
    }

    /**
     * Allow decorators to implement custom methods
     *
     * @param string $method Missing method name
     * @param array  $args   Method arguments
     *
     * @return mixed
     */
    public function __call($method, array $args)
    {
        $result = call_user_func_array([$this->stream, $method], $args);

        // Always return the wrapped object if the result is a return $this
        return $result === $this->stream ? $this : $result;
    }

    public function close()
    {
        $this->stream->close();
    }

    public function getMetadata($key = null)
    {
        return $this->stream->getMetadata($key);
    }

    public function detach()
    {
        return $this->stream->detach();
    }

    public function getSize()
    {
        return $this->stream->getSize();
    }

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

    public function tell() : int
    {
        return $this->stream->tell();
    }

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

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

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

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

    public function seek($offset, $whence = SEEK_SET)
    {
        $this->stream->seek($offset, $whence);
    }

    public function read($length)
    {
        return $this->stream->read($length);
    }

    public function write($string)
    {
        return $this->stream->write($string);
    }

    /**
     * Implement in subclasses to dynamically create streams when requested.
     *
     * @return StreamInterface
     * @throws \BadMethodCallException
     */
    protected function createStream()
    {
        throw new \BadMethodCallException('Not implemented');
    }
}


1		<?php
2
3		namespace Thruster\Component\HttpMessage;
4
5		use Psr\Http\Message\StreamInterface;
6		use function Thruster\Component\HttpMessage\copy_to_string;
7
8		/**
9		* Trait StreamDecoratorTrait
10		*
11		* @package Thruster\Component\HttpMessage
12		* @author Aurimas Niekis <[email protected]>
13		*/
14		trait StreamDecoratorTrait
15		{
16		/**
17		* @param StreamInterface $stream Stream to decorate
18		*/
19	18	public function __construct(StreamInterface $stream)
20		{
21	18	$this->stream = $stream;
		0 ignored issues – show Bug introduced 2016-02-10 23:41 UTC by Report Bug Copy Issue Report The property `stream` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
22	18	}
23
24		/**
25		* Magic method used to create a new stream if streams are not added in
26		* the constructor of a decorator (e.g., LazyOpenStream).
27		*
28		* @param string $name Name of the property (allows "stream" only).
29		*
30		* @return StreamInterface
31		*/
32	9	public function __get($name)
33		{
34	9	if ('stream' == $name) {
35	8	$this->stream = $this->createStream();
36
37	7	return $this->stream;
38		}
39
40	1	throw new \UnexpectedValueException("$name not found on class");
41		}
42
43	19	public function __toString()
44		{
45		try {
46	19	if ($this->isSeekable()) {
47	15	$this->seek(0);
48		}
49
50	19	return $this->getContents();
51	1	} catch (\Exception $e) {
52		// Really, PHP? https://bugs.php.net/bug.php?id=53648
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-10 23:41 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53	1	trigger_error('StreamDecorator::__toString exception: '
54	1	. (string) $e, E_USER_ERROR);
55	1	return '';
56		}
57		}
58
59	23	public function getContents()
60		{
61	23	return copy_to_string($this);
62		}
63
64		/**
65		* Allow decorators to implement custom methods
66		*
67		* @param string $method Missing method name
68		* @param array $args Method arguments
69		*
70		* @return mixed
71		*/
72		public function __call($method, array $args)
73		{
74		$result = call_user_func_array([$this->stream, $method], $args);
75
76		// Always return the wrapped object if the result is a return $this
77		return $result === $this->stream ? $this : $result;
78		}
79
80	3	public function close()
81		{
82	3	$this->stream->close();
83	3	}
84
85	3	public function getMetadata($key = null)
86		{
87	3	return $this->stream->getMetadata($key);
88		}
89
90	2	public function detach()
91		{
92	2	return $this->stream->detach();
93		}
94
95	4	public function getSize()
96		{
97	4	return $this->stream->getSize();
98		}
99
100	15	public function eof() : bool
101		{
102	15	return $this->stream->eof();
103		}
104
105	8	public function tell() : int
106		{
107	8	return $this->stream->tell();
108		}
109
110	4	public function isReadable() : bool
111		{
112	4	return $this->stream->isReadable();
113		}
114
115	3	public function isWritable() : bool
116		{
117	3	return $this->stream->isWritable();
118		}
119
120	19	public function isSeekable() : bool
121		{
122	19	return $this->stream->isSeekable();
123		}
124
125		public function rewind()
126		{
127		$this->seek(0);
128		}
129
130	12	public function seek($offset, $whence = SEEK_SET)
131		{
132	12	$this->stream->seek($offset, $whence);
133	12	}
134
135	16	public function read($length)
136		{
137	16	return $this->stream->read($length);
138		}
139
140	6	public function write($string)
141		{
142	6	return $this->stream->write($string);
143		}
144
145		/**
146		* Implement in subclasses to dynamically create streams when requested.
147		*
148		* @return StreamInterface
149		* @throws \BadMethodCallException
150		*/
151	1	protected function createStream()
152		{
153	1	throw new \BadMethodCallException('Not implemented');
154		}
155		}
156

ThrusterIO / http-message

StreamDecoratorTrait::getContents() A last analyzed 2016-02-11 01:19 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

StreamDecoratorTrait::getContents() A
last analyzed 2016-02-11 01:19 UTC