TraderInteractive\Api\Response

Complexity

Total Complexity

6

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
A	getHttpCode()	0	4	1
A	getResponse()	0	4	1
A	getResponseHeaders()	0	4	1

<?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(int $httpCode, array $headers, array $body = [])
    {
        Util::throwIfNotType(['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() : int
    {
        return $this->httpCode;
    }

    /**
     * Returns an array representing the response from the API
     *
     * @return array
     */
    public function getResponse() : array
    {
        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() : array
    {
        return $this->headers;
    }
}