MemoryStream::__toString() - Code Metrics - Inspection of "Merge branch '2.1' into remove-yii-autoloader" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — remove-yii-autoloader ( 560d61...5f8600 )

by Alexander

created 2017-09-06 20:03 UTC

MemoryStream::__toString() A

↳ Parent: MemoryStream

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\http;

use Psr\Http\Message\StreamInterface;
use yii\base\BaseObject;
use yii\base\InvalidArgumentException;

/**
 * MemoryStream uses internal field as a stream source. Thus data associated with this stream exists only in
 * memory and will be lost once stream is closed.
 *
 * Example:
 *
 * ```php
 * $stream = new MemoryStream();
 *
 * $stream->write('some content...');
 * // ...
 * $stream->rewind();
 * echo $stream->getContents();
 * ```
 *
 * @author Paul Klimov <[email protected]>
 * @since 2.1.0
 */
class MemoryStream extends BaseObject implements StreamInterface
{
    /**
     * @var string internal content.
     */
    private $buffer = '';
    /**
     * @var int internal stream pointer.
     */
    private $pointer = 0;


    /**
     * {@inheritdoc}
     */
    public function __toString()
    {
        return $this->buffer;
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        $this->buffer = '';
        $this->pointer = 0;
    }

    /**
     * {@inheritdoc}
     */
    public function detach()
    {
        $this->close();
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function getSize()
    {
        return strlen($this->buffer);
    }

    /**
     * {@inheritdoc}
     */
    public function tell()
    {
        return $this->pointer;
    }

    /**
     * {@inheritdoc}
     */
    public function eof()
    {
        return $this->pointer >= $this->getSize();
    }

    /**
     * {@inheritdoc}
     */
    public function isSeekable()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        switch ($whence) {
            case SEEK_SET:
                $this->pointer = $offset;
                break;
            case SEEK_CUR:
                $this->pointer += $offset;
                break;
            case SEEK_END:
                $this->pointer = $this->getSize() + $offset;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
                break;
            default:
                throw new InvalidArgumentException("Unknown seek whence: '{$whence}'.");
        }
    }

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

    /**
     * {@inheritdoc}
     */
    public function isWritable()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function write($string)
    {
        $size = $this->getSize();
        $writeSize = strlen($string);

        if ($this->pointer >= $size) {
            $this->buffer .= $string;
            $this->pointer = $size + $writeSize;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            return $writeSize;
        }

        $begin = substr($this->buffer, 0, $this->pointer);
        $end = substr($this->buffer, $this->pointer + $writeSize);

        $this->buffer = $begin . $string . $end;
        $this->pointer += $writeSize;
        return $writeSize;
    }

    /**
     * {@inheritdoc}
     */
    public function isReadable()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function read($length)
    {
        $data = substr($this->buffer, $this->pointer, $length);
        $this->pointer += $length;
        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function getContents()
    {
        if ($this->pointer === 0) {
            return $this->buffer;
        }
        return substr($this->buffer, $this->pointer);
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($key = null)
    {
        $metadata = [
            'mode' => 'rw',
            'seekable' => $this->isSeekable(),
        ];

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

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

1			<?php
2			/**
3			* @link http://www.yiiframework.com/
4			* @copyright Copyright (c) 2008 Yii Software LLC
5			* @license http://www.yiiframework.com/license/
6			*/
7
8			namespace yii\http;
9
10			use Psr\Http\Message\StreamInterface;
11			use yii\base\BaseObject;
12			use yii\base\InvalidArgumentException;
13
14			/**
15			* MemoryStream uses internal field as a stream source. Thus data associated with this stream exists only in
16			* memory and will be lost once stream is closed.
17			*
18			* Example:
19			*
20			* ```php
21			* $stream = new MemoryStream();
22			*
23			* $stream->write('some content...');
24			* // ...
25			* $stream->rewind();
26			* echo $stream->getContents();
27			* ```
28			*
29			* @author Paul Klimov <[email protected]>
30			* @since 2.1.0
31			*/
32			class MemoryStream extends BaseObject implements StreamInterface
33			{
34			/**
35			* @var string internal content.
36			*/
37			private $buffer = '';
38			/**
39			* @var int internal stream pointer.
40			*/
41			private $pointer = 0;
42
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function __toString()
48			{
49			return $this->buffer;
50			}
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function close()
56			{
57			$this->buffer = '';
58			$this->pointer = 0;
59			}
60
61			/**
62			* {@inheritdoc}
63			*/
64			public function detach()
65			{
66			$this->close();
67			return null;
68			}
69
70			/**
71			* {@inheritdoc}
72			*/
73			public function getSize()
74			{
75			return strlen($this->buffer);
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function tell()
82			{
83			return $this->pointer;
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89			public function eof()
90			{
91			return $this->pointer >= $this->getSize();
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function isSeekable()
98			{
99			return true;
100			}
101
102			/**
103			* {@inheritdoc}
104			*/
105			public function seek($offset, $whence = SEEK_SET)
106			{
107			switch ($whence) {
108			case SEEK_SET:
109			$this->pointer = $offset;
110			break;
111			case SEEK_CUR:
112			$this->pointer += $offset;
113			break;
114			case SEEK_END:
115			$this->pointer = $this->getSize() + $offset;
			0 ignored issues – show Documentation Bug introduced 2017-08-27 23:11 UTC by Report Bug Copy Issue Report It seems like `$this->getSize() + $offset` can also be of type `double`. However, the property `$pointer` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
116			break;
117			default:
118			throw new InvalidArgumentException("Unknown seek whence: '{$whence}'.");
119			}
120			}
121
122			/**
123			* {@inheritdoc}
124			*/
125			public function rewind()
126			{
127			$this->seek(0);
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133			public function isWritable()
134			{
135			return true;
136			}
137
138			/**
139			* {@inheritdoc}
140			*/
141			public function write($string)
142			{
143			$size = $this->getSize();
144			$writeSize = strlen($string);
145
146			if ($this->pointer >= $size) {
147			$this->buffer .= $string;
148			$this->pointer = $size + $writeSize;
			0 ignored issues – show Documentation Bug introduced 2017-08-27 23:11 UTC by Report Bug Copy Issue Report It seems like `$size + $writeSize` can also be of type `double`. However, the property `$pointer` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
149			return $writeSize;
150			}
151
152			$begin = substr($this->buffer, 0, $this->pointer);
153			$end = substr($this->buffer, $this->pointer + $writeSize);
154
155			$this->buffer = $begin . $string . $end;
156			$this->pointer += $writeSize;
157			return $writeSize;
158			}
159
160			/**
161			* {@inheritdoc}
162			*/
163			public function isReadable()
164			{
165			return true;
166			}
167
168			/**
169			* {@inheritdoc}
170			*/
171			public function read($length)
172			{
173			$data = substr($this->buffer, $this->pointer, $length);
174			$this->pointer += $length;
175			return $data;
176			}
177
178			/**
179			* {@inheritdoc}
180			*/
181			public function getContents()
182			{
183			if ($this->pointer === 0) {
184			return $this->buffer;
185			}
186			return substr($this->buffer, $this->pointer);
187			}
188
189			/**
190			* {@inheritdoc}
191			*/
192			public function getMetadata($key = null)
193			{
194			$metadata = [
195			'mode' => 'rw',
196			'seekable' => $this->isSeekable(),
197			];
198
199			if ($key === null) {
200			return $metadata;
201			}
202
203			return (isset($metadata[$key])) ? $metadata[$key] : null;
204			}
205			}

yiisoft / yii2

Push — remove-yii-autoloader ( 560d61...5f8600 )

MemoryStream::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like