ResponseBuilder::respond() - Code Metrics - Inspection of "Fix merge" - flugger/laravel-responder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1092e2...11ab51 )

by Alexander

created 2016-08-30 20:44 UTC

ResponseBuilder::respond() A

↳ Parent: ResponseBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	10
rs	9.4285

<?php

namespace Flugg\Responder\Http;

use Illuminate\Contracts\Routing\ResponseFactory;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use JsonSerializable;

/**
 * This class is an abstract response builder and hold common functionality the success-
 * and error response buuilder classes.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <[email protected]>
 * @license The MIT License
 */
abstract class ResponseBuilder implements Arrayable, Jsonable, JsonSerializable
{
    /**
     * Flag indicating if status code should be added to the serialized data.
     *
     * @var bool
     */
    protected $includeStatusCode;

    /**
     * The HTTP status code for the response.
     *
     * @var int
     */
    protected $statusCode;

    /**
     * Response factory used to generate JSON responses.
     *
     * @var \Illuminate\Contracts\Routing\ResponseFactory
     */
    protected $responseFactory;

    /**
     * Constructor.
     *
     * @param \Illuminate\Contracts\Routing\ResponseFactory $responseFactory
     */
    public function __construct(ResponseFactory $responseFactory)
    {
        $this->responseFactory = $responseFactory;
    }

    /**
     * Serialize the data and wrap it in a JSON response object.
     *
     * @param  int|null $statusCode
     * @param  array    $headers
     * @return \Illuminate\Http\JsonResponse
     */
    public function respond(int $statusCode = null, array $headers = []):JsonResponse
    {
        if (! is_null($statusCode)) {
            $this->setStatus($statusCode);
        }

        $data = $this->includeStatusCode($this->toArray());

        return $this->responseFactory->json($data, $this->statusCode, $headers);
    }

    /**
     * Set the HTTP status code for the response.
     *
     * @param  int $statusCode
     * @return self
     */
    public function setStatus(int $statusCode):ResponseBuilder
    {
        $this->statusCode = $statusCode;

        return $this;
    }

    /**
     * Set a flag indicating if status code should be added to the response.
     *
     * @param  bool $includeStatusCode
     * @return self
     */
    public function setIncludeStatusCode(bool $includeStatusCode):ResponseBuilder
    {
        $this->includeStatusCode = $includeStatusCode;

        return $this;
    }

    /**
     * Convert the response to an Illuminate collection.
     *
     * @return \Illuminate\Support\Collection
     */
    public function toCollection():Collection
    {
        return new Collection($this->toArray());
    }

    /**
     * Convert the response to JSON.
     *
     * @param  int $options
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Convert the response to an array.
     *
     * @return array
     */
    abstract public function toArray():array;

    /**
     * Include a status code to the serialized data if enabled.
     *
     * @param  array $data
     * @return array
     */
    protected function includeStatusCode(array $data):array
    {
        if (! $this->includeStatusCode) {
            return $data;
        }

        return array_merge(['status' => $this->statusCode], $data);;
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
    }
}

1			<?php
2
3			namespace Flugg\Responder\Http;
4
5			use Illuminate\Contracts\Routing\ResponseFactory;
6			use Illuminate\Contracts\Support\Arrayable;
7			use Illuminate\Contracts\Support\Jsonable;
8			use Illuminate\Http\JsonResponse;
9			use Illuminate\Support\Collection;
10			use JsonSerializable;
11
12			/**
13			* This class is an abstract response builder and hold common functionality the success-
14			* and error response buuilder classes.
15			*
16			* @package flugger/laravel-responder
17			* @author Alexander Tømmerås <[email protected]>
18			* @license The MIT License
19			*/
20			abstract class ResponseBuilder implements Arrayable, Jsonable, JsonSerializable
21			{
22			/**
23			* Flag indicating if status code should be added to the serialized data.
24			*
25			* @var bool
26			*/
27			protected $includeStatusCode;
28
29			/**
30			* The HTTP status code for the response.
31			*
32			* @var int
33			*/
34			protected $statusCode;
35
36			/**
37			* Response factory used to generate JSON responses.
38			*
39			* @var \Illuminate\Contracts\Routing\ResponseFactory
40			*/
41			protected $responseFactory;
42
43			/**
44			* Constructor.
45			*
46			* @param \Illuminate\Contracts\Routing\ResponseFactory $responseFactory
47			*/
48			public function __construct(ResponseFactory $responseFactory)
49			{
50			$this->responseFactory = $responseFactory;
51			}
52
53			/**
54			* Serialize the data and wrap it in a JSON response object.
55			*
56			* @param int\|null $statusCode
57			* @param array $headers
58			* @return \Illuminate\Http\JsonResponse
59			*/
60			public function respond(int $statusCode = null, array $headers = []):JsonResponse
61			{
62			if (! is_null($statusCode)) {
63			$this->setStatus($statusCode);
64			}
65
66			$data = $this->includeStatusCode($this->toArray());
67
68			return $this->responseFactory->json($data, $this->statusCode, $headers);
69			}
70
71			/**
72			* Set the HTTP status code for the response.
73			*
74			* @param int $statusCode
75			* @return self
76			*/
77			public function setStatus(int $statusCode):ResponseBuilder
78			{
79			$this->statusCode = $statusCode;
80
81			return $this;
82			}
83
84			/**
85			* Set a flag indicating if status code should be added to the response.
86			*
87			* @param bool $includeStatusCode
88			* @return self
89			*/
90			public function setIncludeStatusCode(bool $includeStatusCode):ResponseBuilder
91			{
92			$this->includeStatusCode = $includeStatusCode;
93
94			return $this;
95			}
96
97			/**
98			* Convert the response to an Illuminate collection.
99			*
100			* @return \Illuminate\Support\Collection
101			*/
102			public function toCollection():Collection
103			{
104			return new Collection($this->toArray());
105			}
106
107			/**
108			* Convert the response to JSON.
109			*
110			* @param int $options
111			* @return string
112			*/
113			public function toJson($options = 0)
114			{
115			return json_encode($this->jsonSerialize(), $options);
116			}
117
118			/**
119			* Convert the object into something JSON serializable.
120			*
121			* @return array
122			*/
123			public function jsonSerialize()
124			{
125			return $this->toArray();
126			}
127
128			/**
129			* Convert the response to an array.
130			*
131			* @return array
132			*/
133			abstract public function toArray():array;
134
135			/**
136			* Include a status code to the serialized data if enabled.
137			*
138			* @param array $data
139			* @return array
140			*/
141			protected function includeStatusCode(array $data):array
142			{
143			if (! $this->includeStatusCode) {
144			return $data;
145			}
146
147			return array_merge(['status' => $this->statusCode], $data);;
			0 ignored issues – show Coding Style introduced 2016-08-30 20:50 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
148			}
149			}

flugger / laravel-responder

Push — master ( 1092e2...11ab51 )

ResponseBuilder::respond() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like