StreamFactory::createStreamFromResource() - Code Metrics - Inspection of "Update to new PSR17 (#46)" - Nyholm/psr7 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4e07a2...96fcad )

by Tobias

created 2018-07-23 00:15 UTC

StreamFactory::createStreamFromResource() A

↳ Parent: StreamFactory::copyToStream()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Nyholm\Psr7\Factory;

use Nyholm\Psr7\Stream;
use Psr\Http\Message\StreamInterface;

/**
 * @author Tobias Nyholm <[email protected]>
 */
class StreamFactory implements \Http\Message\StreamFactory
{
    public function createStream($body = null)
    {
        if ($body instanceof StreamInterface) {
            return $body;
        }

        if ('resource' === gettype($body)) {
            return Stream::createFromResource($body);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return Stream::create(null === $body ? '' : $body);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Copy the contents of a stream into another stream until the given number
     * of bytes have been read.
     *
     * @author Michael Dowling and contributors to guzzlehttp/psr7
     *
     * @param StreamInterface $source Stream to read from
     * @param StreamInterface $dest   Stream to write to
     * @param int             $maxLen Maximum number of bytes to read. Pass -1
     *                                to read the entire stream
     *
     * @throws \RuntimeException on error
     */
    public function copyToStream(StreamInterface $source, StreamInterface $dest, $maxLen = -1)
    {
        if ($maxLen === -1) {
            while (!$source->eof()) {
                if (!$dest->write($source->read(1048576))) {
                    break;
                }
            }

            return;
        }

        $bytes = 0;
        while (!$source->eof()) {
            $buf = $source->read($maxLen - $bytes);
            if (!($len = strlen($buf))) {
                break;
            }
            $bytes += $len;
            $dest->write($buf);
            if ($bytes === $maxLen) {
                break;
            }
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Nyholm\Psr7\Factory;
6
7		use Nyholm\Psr7\Stream;
8		use Psr\Http\Message\StreamInterface;
9
10		/**
11		* @author Tobias Nyholm <[email protected]>
12		*/
13		class StreamFactory implements \Http\Message\StreamFactory
14		{
15		public function createStream($body = null)
16		{
17		if ($body instanceof StreamInterface) {
18		return $body;
19		}
20
21		if ('resource' === gettype($body)) {
22		return Stream::createFromResource($body);
		0 ignored issues – show Bug Best Practice introduced 2017-12-03 21:49 UTC by Report Bug Copy Issue Report The return type of `return \Nyholm\Psr7\Stre...ateFromResource($body);` (`self`) is incompatible with the return type declared by the interface `Http\Message\StreamFactory::createStream` of type `Psr\Http\Message\StreamInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
23		}
24
25		return Stream::create(null === $body ? '' : $body);
		0 ignored issues – show Bug Best Practice introduced 2017-12-03 21:49 UTC by Report Bug Copy Issue Report The return type of `return \Nyholm\Psr7\Stre...== $body ? '' : $body);` (`self`) is incompatible with the return type declared by the interface `Http\Message\StreamFactory::createStream` of type `Psr\Http\Message\StreamInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
26		}
27
28		/**
29		* Copy the contents of a stream into another stream until the given number
30		* of bytes have been read.
31		*
32		* @author Michael Dowling and contributors to guzzlehttp/psr7
33		*
34		* @param StreamInterface $source Stream to read from
35		* @param StreamInterface $dest Stream to write to
36		* @param int $maxLen Maximum number of bytes to read. Pass -1
37		* to read the entire stream
38		*
39		* @throws \RuntimeException on error
40		*/
41	4	public function copyToStream(StreamInterface $source, StreamInterface $dest, $maxLen = -1)
42		{
43	4	if ($maxLen === -1) {
44	4	while (!$source->eof()) {
45	4	if (!$dest->write($source->read(1048576))) {
46	4	break;
47		}
48		}
49
50	4	return;
51		}
52
53		$bytes = 0;
54		while (!$source->eof()) {
55		$buf = $source->read($maxLen - $bytes);
56		if (!($len = strlen($buf))) {
57		break;
58		}
59		$bytes += $len;
60		$dest->write($buf);
61		if ($bytes === $maxLen) {
62		break;
63		}
64		}
65		}
66		}
67

Nyholm / psr7

Push — master ( 4e07a2...96fcad )

StreamFactory::createStreamFromResource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like