ByJG\RestServer\HttpResponse

Complexity

Total Complexity

16

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Test Coverage

Coverage

54.29%

Importance

Changes	3
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	addHeader()	0	3	1
A	addCookie()	0	6	2
A	removeSession()	0	3	1
A	getResponseCode()	0	3	1
A	write()	0	3	1
A	__construct()	0	3	1
A	getHeaders()	0	3	1
A	getResponseBag()	0	3	1
A	removeCookie()	0	4	1
A	getResponseCodeDescription()	0	3	1
A	emptyResponse()	0	3	1
A	setResponseCode()	0	4	1
A	setSession()	0	3	1
A	writeDebug()	0	8	2

<?php

namespace ByJG\RestServer;

class HttpResponse
{

    /**
     * @var ResponseBag
     */
    protected $response;

    /**
     * @var ResponseBag
     */
    protected $responseDebug;

    /**
     * @var array
     */
    protected $headers = [];

    /**
     * @var int
     */
    protected $responseCode = 200;
    protected $responseCodeDescription = 'OK';

    public function __construct()
    {
        $this->emptyResponse();
    }

    /**
     * Add a value in session
     *
     * @param string $name
     * @param string $value
     */
    public function setSession($name, $value)
    {
        $_SESSION[$name] = $value;
    }

    /**
     * Remove a value in this session
     *
     * @param string $name
     */
    public function removeSession($name)
    {
        unset($_SESSION[$name]);
    }

    /**
     * Add a cookie value
     *
     * @param string $name
     * @param string $value
     * @param int $expire (seconds from now)
     * @param int $path (directory into domain in which the cookie will be available on )
     * @param string $domain
     */
    public function addCookie($name, $value, $expire = null, $path = null, $domain = null)
    {
        if (!is_null($expire)) {
            $expire = time() + $expire;
        }
        setcookie($name, $value, $expire, $path, $domain);
    }

    /**
     * Delete a cookie
     *
     * @param string $name
     */
    public function removeCookie($name)
    {
        setcookie($name, null, time() - 3600);
        unset($_COOKIE[$name]);
    }

    /**
     * ResponseBag is a collection of objects will be returned to the  client. RestServer call handle the ResponseBag to
     * return the proper output. Avoid to use it directly here. Prefer the methods write or writeDebug;
     *
     * @return ResponseBag
     */
    public function getResponseBag()
    {
        return $this->response;
    }

    /**
     * Add an array, model or stdClass to be processed.
     *
     * @param mixed $object
     */
    public function write($object)
    {
        $this->response->add($object);
    }

    /**
     * Added informations for debug purposes only.
     * In case the error it will showed and the result a node called "debug" will be added.
     *
     * @param string $key
     * @param mixed $string
     */
    public function writeDebug($key, $string)
    {
        // @todo Review this.
        if (is_null($this->responseDebug)) {
            $this->responseDebug = new ResponseBag();
            $this->response->add($this->responseDebug);
        }
        $this->responseDebug->add(['debug' => [$key => $string]]);
        // ErrorHandler::getInstance()->addExtraInfo($key, serialize($string));
    }

    public function emptyResponse()
    {
        $this->response = new ResponseBag();
    }

    /**
     * Undocumented function
     *
     * @param string $header
     * @param string|array $value
     * @return void
     */
    public function addHeader($header, $value)
    {
        $this->headers[$header] = $value;
    }

    public function getHeaders()
    {
        return $this->headers;
    }

    public function setResponseCode($code, $description = "")
    {
        $this->responseCode = $code;
        $this->responseCodeDescription = $description;
    }

    public function getResponseCode()
    {
        return $this->responseCode;
    }

    public function getResponseCodeDescription()
    {
        return $this->responseCodeDescription;
    }
}