ResponseFactory::json() - Code Metrics - Wandu/Framework - Measure and Improve Code Quality continuously with Scrutinizer

ResponseFactory::json() A
last analyzed 2018-03-08 03:43 UTC

↳ Parent: ResponseFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
namespace Wandu\Http\Factory;

use Closure;
use Generator;
use InvalidArgumentException;
use JsonSerializable;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
use RuntimeException;
use Traversable;
use Wandu\Http\Psr\Response;
use Wandu\Http\Psr\Stream\IteratorStream;
use Wandu\Http\Psr\Stream\ResourceStream;
use Wandu\Http\Psr\Stream\StringStream;

class ResponseFactory
{
    /** @var \Wandu\Http\Factory\ResponseFactory */
    public static $instance;

    /**
     * @param mixed $contents
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function auto($contents = null, $status = 200, array $headers = [])
    {
        if ($contents instanceof ResponseInterface) {
            return $contents;
        }
        if ($contents instanceof StreamInterface || !isset($contents)) {
            return $this->create($contents, $status, $headers);
        }
        while (is_callable($contents)) {
            $nextResponse = call_user_func($contents);
            $contents = $nextResponse;
        }
        // int, float, boolean, string
        if (is_scalar($contents)) {
            if ($contents === true) {
                $contents = 'true';
            } elseif ($contents === false) {
                $contents = 'false';
            }
            return $this->string((string)$contents, $status, $headers);
        }
        if (is_array($contents)) {
            return $this->json($contents, $status, $headers);
        }
        if (is_object($contents)) {
            if ($contents instanceof Traversable) {
                return $this->iterator($contents, $status, $headers);
            } elseif ($contents instanceof JsonSerializable) {

                return $this->json($contents, $status, $headers);
            } elseif (method_exists($contents, '__toString')) {
                return $this->string($contents, $status, $headers);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            } else {
                return $this->json($contents, $status, $headers);
            }
        }
        if (is_resource($contents)) {
            return $this->resource($contents, $status, $headers);
        }
        throw new RuntimeException('unsupported type of response.');
    }
    
    /**
     * @param \Psr\Http\Message\StreamInterface $stream
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function create(StreamInterface $stream = null, $status = 200, array $headers = [])
    {
        return new Response($status, $stream, $headers, '', '1.1');
    }

    /**
     * @param \Closure $area
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function capture(Closure $area, $status = 200, array $headers = [])
    {
        ob_start();
        $area();
        $contents = ob_get_contents();
        ob_end_clean();
        return $this->string($contents, $status, $headers);
    }

    /**
     * @param string $contents
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function string(string $contents, $status = 200, array $headers = [])
    {
        return $this->create(new StringStream($contents), $status, $headers);
    }
    
    /**
     * @param mixed $data
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function json($data = [], $status = 200, array $headers = [])
    {
        return $this->create(new StringStream(json_encode($data)), $status, $headers)
            ->withHeader('Content-Type', 'application/json');
    }

    /**
     * @param string $file
     * @param string $name
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function download($file, $name = null, array $headers = [])
    {
        if (!is_file($file)) {
            new InvalidArgumentException("\"{$file}\" is not a file.");
        }
        return $this->create(new StringStream(file_get_contents($file)), 200, $headers)
            ->withHeader('Pragma', 'public')
            ->withHeader('Expires', '0')
            ->withHeader('Content-Type', 'application/octet-stream')
            ->withHeader(
                'Content-Disposition',
                'attachment; filename=' . (isset($name) ? $name : basename($file))
            )
            ->withHeader('Content-Transfer-Encoding', 'binary')
            ->withHeader('Content-Length', filesize($file) . '');
    }

    /**
     * @param \Psr\Http\Message\UriInterface|string $path
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function redirect($path, $status = 302, $headers = [])
    {
        if ($path instanceof UriInterface) {
            $path = $path->__toString();
        }
        return $this->create(null, $status, $headers)
            ->withStatus($status)
            ->withAddedHeader('Location', $path);
    }

    /**
     * @deprecated use iterator
     * 
     * @param \Generator $generator
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function generator(Generator $generator, $status = 200, array $headers = [])
    {
        return $this->create(new Iteratorstream($generator), $status, $headers);
    }

    /**
     * @param \Traversable $iterator
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function iterator(Traversable $iterator, $status = 200, array $headers = [])
    {
        return $this->create(new IteratorStream($iterator), $status, $headers);
    }

    /**
     * @param resource $resource
     * @param int $status
     * @param array $headers
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function resource($resource, $status = 200, array $headers = [])
    {
        return $this->create(new ResourceStream($resource), $status, $headers);
    }
}


1		<?php
2		namespace Wandu\Http\Factory;
3
4		use Closure;
5		use Generator;
6		use InvalidArgumentException;
7		use JsonSerializable;
8		use Psr\Http\Message\ResponseInterface;
9		use Psr\Http\Message\StreamInterface;
10		use Psr\Http\Message\UriInterface;
11		use RuntimeException;
12		use Traversable;
13		use Wandu\Http\Psr\Response;
14		use Wandu\Http\Psr\Stream\IteratorStream;
15		use Wandu\Http\Psr\Stream\ResourceStream;
16		use Wandu\Http\Psr\Stream\StringStream;
17
18		class ResponseFactory
19		{
20		/** @var \Wandu\Http\Factory\ResponseFactory */
21		public static $instance;
22
23		/**
24		* @param mixed $contents
25		* @param int $status
26		* @param array $headers
27		* @return \Psr\Http\Message\ResponseInterface
28		*/
29	19	public function auto($contents = null, $status = 200, array $headers = [])
30		{
31	19	if ($contents instanceof ResponseInterface) {
32	3	return $contents;
33		}
34	18	if ($contents instanceof StreamInterface \|\| !isset($contents)) {
35	6	return $this->create($contents, $status, $headers);
36		}
37	14	while (is_callable($contents)) {
38	3	$nextResponse = call_user_func($contents);
39	3	$contents = $nextResponse;
40		}
41		// int, float, boolean, string
42	14	if (is_scalar($contents)) {
43	9	if ($contents === true) {
44	2	$contents = 'true';
45	8	} elseif ($contents === false) {
46	2	$contents = 'false';
47		}
48	9	return $this->string((string)$contents, $status, $headers);
49		}
50	6	if (is_array($contents)) {
51	2	return $this->json($contents, $status, $headers);
52		}
53	5	if (is_object($contents)) {
54	4	if ($contents instanceof Traversable) {
55	2	return $this->iterator($contents, $status, $headers);
56	2	} elseif ($contents instanceof JsonSerializable) {
		0 ignored issues – show Bug introduced 2017-07-11 05:42 UTC by Report Bug Copy Issue Report The class `JsonSerializable` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
57	1	return $this->json($contents, $status, $headers);
58	2	} elseif (method_exists($contents, '__toString')) {
59	1	return $this->string($contents, $status, $headers);
		0 ignored issues – show Documentation introduced 2017-07-04 05:47 UTC by Report Bug Copy Issue Report `$contents` is of type `object`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
60		} else {
61	1	return $this->json($contents, $status, $headers);
62		}
63		}
64	2	if (is_resource($contents)) {
65	2	return $this->resource($contents, $status, $headers);
66		}
67		throw new RuntimeException('unsupported type of response.');
68		}
69
70		/**
71		* @param \Psr\Http\Message\StreamInterface $stream
72		* @param int $status
73		* @param array $headers
74		* @return \Psr\Http\Message\ResponseInterface
75		*/
76	31	public function create(StreamInterface $stream = null, $status = 200, array $headers = [])
77		{
78	31	return new Response($status, $stream, $headers, '', '1.1');
79		}
80
81		/**
82		* @param \Closure $area
83		* @param int $status
84		* @param array $headers
85		* @return \Psr\Http\Message\ResponseInterface
86		*/
87	2	public function capture(Closure $area, $status = 200, array $headers = [])
88		{
89	2	ob_start();
90	2	$area();
91	2	$contents = ob_get_contents();
92	2	ob_end_clean();
93	2	return $this->string($contents, $status, $headers);
94		}
95
96		/**
97		* @param string $contents
98		* @param int $status
99		* @param array $headers
100		* @return \Psr\Http\Message\ResponseInterface
101		*/
102	17	public function string(string $contents, $status = 200, array $headers = [])
103		{
104	17	return $this->create(new StringStream($contents), $status, $headers);
105		}
106
107		/**
108		* @param mixed $data
109		* @param int $status
110		* @param array $headers
111		* @return \Psr\Http\Message\ResponseInterface
112		*/
113	5	public function json($data = [], $status = 200, array $headers = [])
114		{
115	5	return $this->create(new StringStream(json_encode($data)), $status, $headers)
116	5	->withHeader('Content-Type', 'application/json');
117		}
118
119		/**
120		* @param string $file
121		* @param string $name
122		* @param array $headers
123		* @return \Psr\Http\Message\ResponseInterface
124		*/
125		public function download($file, $name = null, array $headers = [])
126		{
127		if (!is_file($file)) {
128		new InvalidArgumentException("\"{$file}\" is not a file.");
129		}
130		return $this->create(new StringStream(file_get_contents($file)), 200, $headers)
131		->withHeader('Pragma', 'public')
132		->withHeader('Expires', '0')
133		->withHeader('Content-Type', 'application/octet-stream')
134		->withHeader(
135		'Content-Disposition',
136		'attachment; filename=' . (isset($name) ? $name : basename($file))
137		)
138		->withHeader('Content-Transfer-Encoding', 'binary')
139		->withHeader('Content-Length', filesize($file) . '');
140		}
141
142		/**
143		* @param \Psr\Http\Message\UriInterface\|string $path
144		* @param int $status
145		* @param array $headers
146		* @return \Psr\Http\Message\ResponseInterface
147		*/
148	2	public function redirect($path, $status = 302, $headers = [])
149		{
150	2	if ($path instanceof UriInterface) {
151		$path = $path->__toString();
152		}
153	2	return $this->create(null, $status, $headers)
154	2	->withStatus($status)
155	2	->withAddedHeader('Location', $path);
156		}
157
158		/**
159		* @deprecated use iterator
160		*
161		* @param \Generator $generator
162		* @param int $status
163		* @param array $headers
164		* @return \Psr\Http\Message\ResponseInterface
165		*/
166		public function generator(Generator $generator, $status = 200, array $headers = [])
167		{
168		return $this->create(new Iteratorstream($generator), $status, $headers);
169		}
170
171		/**
172		* @param \Traversable $iterator
173		* @param int $status
174		* @param array $headers
175		* @return \Psr\Http\Message\ResponseInterface
176		*/
177	4	public function iterator(Traversable $iterator, $status = 200, array $headers = [])
178		{
179	4	return $this->create(new IteratorStream($iterator), $status, $headers);
180		}
181
182		/**
183		* @param resource $resource
184		* @param int $status
185		* @param array $headers
186		* @return \Psr\Http\Message\ResponseInterface
187		*/
188	2	public function resource($resource, $status = 200, array $headers = [])
189		{
190	2	return $this->create(new ResourceStream($resource), $status, $headers);
191		}
192		}
193

Wandu / Framework

ResponseFactory::json() A last analyzed 2018-03-08 03:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ResponseFactory::json() A
last analyzed 2018-03-08 03:43 UTC