Tequilarapido\ApiResponse\ResponseBuilder

Complexity

Total Complexity

15

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

86.11%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	withCookie()	0	6	1
A	cookie()	0	4	1
A	withHeader()	0	6	1
A	header()	0	4	1
A	setStatusCode()	0	6	1
A	statusCode()	0	4	1
A	build()	0	15	3
A	getCookies()	0	4	1
A	getHeaders()	0	4	1
A	getStatusCode()	0	4	1
A	setMeta()	0	10	2

<?php

namespace Tequilarapido\ApiResponse;

use Illuminate\Http\Response as HttpResponse;
use Symfony\Component\HttpFoundation\Cookie;

/**
 * Inspired from dingo/api.
 *
 * Class ResponseBuilder
 */
class ResponseBuilder
{
    /**
     * Response content.
     *
     * @var mixed
     */
    protected $response;

    /**
     * The HTTP response headers.
     *
     * @var array
     */
    protected $headers = [];

    /**
     * The HTTP response cookies.
     *
     * @var array
     */
    protected $cookies = [];

    /**
     * The HTTP response status code.
     *
     * @var int
     */
    protected $statusCode = 200;

    /**
     * Create a new response builder instance.
     *
     * @param mixed $response
     */
    public function __construct($response)
    {
        $this->response = $response;
    }

    /**
     * Add a cookie to the response.
     *
     * @param \Symfony\Component\HttpFoundation\Cookie $cookie
     *
     * @return ResponseBuilder
     */
    public function withCookie(Cookie $cookie)
    {
        $this->cookies[] = $cookie;

        return $this;
    }

    /**
     * Add a cookie to the response.
     *
     * @param \Symfony\Component\HttpFoundation\Cookie $cookie
     *
     * @return ResponseBuilder
     */
    public function cookie(Cookie $cookie)
    {
        return $this->withCookie($cookie);
    }

    /**
     * Add a header to the response.
     *
     * @param string $name
     * @param string $value
     *
     * @return ResponseBuilder
     */
    public function withHeader($name, $value)
    {
        $this->headers[$name] = $value;

        return $this;
    }

    /**
     * Add a header to the response.
     *
     * @param string $name
     * @param string $value
     *
     * @return ResponseBuilder
     */
    public function header($name, $value)
    {
        return $this->withHeader($name, $value);
    }

    /**
     * Set the responses status code.
     *
     * @param int $statusCode
     *
     * @return ResponseBuilder
     */
    public function setStatusCode($statusCode)
    {
        $this->statusCode = $statusCode;

        return $this;
    }

    /**
     * Set the response status code.
     *
     * @param int $statusCode
     *
     * @return ResponseBuilder
     */
    public function statusCode($statusCode)
    {
        return $this->setStatusCode($statusCode);
    }

    /**
     * Build the response.
     *
     * @return \Illuminate\Http\Response
     */
    public function build()
    {
        $response = new HttpResponse($this->response, $this->statusCode, $this->headers);
        
        // Force json content type
        $response->header('Content-Type', 'application/json');

        foreach ($this->cookies as $cookie) {
            if ($cookie instanceof Cookie) {
                $response->withCookie($cookie);
            }
        }

        return $response;
    }

    /**
     * Returns cookies.
     *
     * @return array
     */
    public function getCookies()
    {
        return $this->cookies;
    }

    /**
     * Return headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Return status code.
     *
     * @return int
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }
    
    /**
     * Add meta to response
     *
     * @param $key
     * @param $value
     * @return $this
     */
    public function setMeta($key, $value)
    {
        if (!isset($this->response['meta'])) {
            $this->response['meta'] = [];
        }

        $this->response['meta'][$key] = $value;
        
        return $this;
    }
}