Response::getResponse() - Code Metrics - Inspection of "[WIP] Version 3" - traderinteractive/tol-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

by Chad

created 2018-02-23 13:02 UTC

Response::getResponse() A

↳ Parent: Response

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
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace TraderInteractive\Api;

use DominionEnterprises\Util;

/**
 * Represents a response to an API request
 */
final class Response
{
    /**
     * The http status of the response.
     *
     * @var int
     */
    private $httpCode;

    /**
     * The response from the API
     *
     * @var array
     */
    private $body;

    /**
     * A array of headers received with the response.
     *
     * @var array array where each header key has an array of values
     */
    private $headers;

    /**
     * Create a new instance of Response
     *
     * @param int $httpCode
     * @param array $headers
     * @param array $body
     *
     * @throws \InvalidArgumentException Throw if $httpCode is not an integer between 100 and 600
     */
    public function __construct($httpCode, array $headers, array $body = [])
    {
        Util::throwIfNotType(['int' => $httpCode, 'array' => $headers]);

        if ($httpCode < 100 || $httpCode > 600) {
            throw new \InvalidArgumentException('$httpCode must be an integer >= 100 and <= 600');
        }

        $this->httpCode = $httpCode;
        $this->headers = $headers;
        $this->body = $body;
    }

    /**
     * Returns the HTTP status code of the response
     *
     * @return int
     */
    public function getHttpCode()
    {
        return $this->httpCode;
    }

    /**
     * Returns an array representing the response from the API
     *
     * @return array
     */
    public function getResponse()
    {
        return $this->body;
    }

    /**
     * Returns the parsed response headers from the API
     *
     * @return array array where each header key has an array of values
     */
    public function getResponseHeaders()
    {
        return $this->headers;
    }
}


1			<?php
2
3			namespace TraderInteractive\Api;
4
5			use DominionEnterprises\Util;
6
7			/**
8			* Represents a response to an API request
9			*/
10			final class Response
11			{
12			/**
13			* The http status of the response.
14			*
15			* @var int
16			*/
17			private $httpCode;
18
19			/**
20			* The response from the API
21			*
22			* @var array
23			*/
24			private $body;
25
26			/**
27			* A array of headers received with the response.
28			*
29			* @var array array where each header key has an array of values
30			*/
31			private $headers;
32
33			/**
34			* Create a new instance of Response
35			*
36			* @param int $httpCode
37			* @param array $headers
38			* @param array $body
39			*
40			* @throws \InvalidArgumentException Throw if $httpCode is not an integer between 100 and 600
41			*/
42			public function __construct($httpCode, array $headers, array $body = [])
43			{
44			Util::throwIfNotType(['int' => $httpCode, 'array' => $headers]);
45
46			if ($httpCode < 100 \|\| $httpCode > 600) {
47			throw new \InvalidArgumentException('$httpCode must be an integer >= 100 and <= 600');
48			}
49
50			$this->httpCode = $httpCode;
51			$this->headers = $headers;
52			$this->body = $body;
53			}
54
55			/**
56			* Returns the HTTP status code of the response
57			*
58			* @return int
59			*/
60			public function getHttpCode()
61			{
62			return $this->httpCode;
63			}
64
65			/**
66			* Returns an array representing the response from the API
67			*
68			* @return array
69			*/
70			public function getResponse()
71			{
72			return $this->body;
73			}
74
75			/**
76			* Returns the parsed response headers from the API
77			*
78			* @return array array where each header key has an array of values
79			*/
80			public function getResponseHeaders()
81			{
82			return $this->headers;
83			}
84			}
85

traderinteractive / tol-api-php

Pull Request — master (#42)

Response::getResponse() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like