Anax\Response\Response

Complexity

Total Complexity

20

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

22.81%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	setStatusCode()	0	13	3
A	getStatusCode()	0	4	1
A	addHeader()	0	5	1
A	checkIfHeadersAlreadySent()	0	6	3
A	sendHeaders()	0	14	3
A	setBody()	0	13	3
A	getBody()	0	4	1
A	send()	0	11	2
A	sendJson()	0	6	1
A	setJsonBody()	0	6	1
A	redirect()	0	6	1

<?php

namespace Anax\Response;

/**
 * Handling a response.
 */
class Response
{
    /**
    * @var array $headers    set all headers to send.
    * @var array $statusCode set statuscode to use.
    * @var array $body       body to send with response.
    */
    private $headers = [];
    private $statusCode;
    private $body;



    /**
     * @var array $validStatusCode these status codes are supported.
     */
    private $validStatusCode = [
        "200" => "HTTP/1.1 200 OK",
        "400" => "HTTP/1.1 400 Bad Request",
        "403" => "HTTP/1.1 403 Forbidden",
        "404" => "HTTP/1.1 404 Not Found",
        "405" => "HTTP/1.1 405 Method Not Allowed",
        "418" => "HTTP/1.1 418 I'm a teapot",
        "500" => "HTTP/1.1 500 Internal Server Error",
        "501" => "HTTP/1.1 501 Not Implemented",
    ];



    /**
     * Set status code to be sent as part of headers.
     *
     * @param string $header type of header to set

There is no parameter named $header. Was it maybe removed?

     *
     * @return self
     */
    public function setStatusCode($value)
    {
        if (is_null($value)) {
            return $this;
        }

        if (!array_key_exists($value, $this->validStatusCode)) {
            throw new Exception("Unsupported statuscode: $value");
        }

        $this->statusCode = $value;
        return $this;
    }



    /**
     * Get status code to be sent as part of headers.
     *
     * @return integer value as status code or null if not set.
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }



    /**
     * Set headers.
     *
     * @param string $header type of header to set
     *
     * @return self
     */
    public function addHeader($header)
    {
        $this->headers[] = $header;
        return $this;
    }



    /**
     * Check if headers are already sent and throw exception if it has,
     * but ignore when running in cli mode.
     *
     * @return void
     *
     * @throws Exception
     */
    public function checkIfHeadersAlreadySent()
    {
        if (php_sapi_name() !== 'cli' && headers_sent($file, $line)) {
            throw new Exception("Try to send headers but headers already sent, output started at $file line $line.");
        }
    }



    /**
     * Send headers.
     *
     * @return self
     */
    public function sendHeaders()
    {
        $this->checkIfHeadersAlreadySent();

        if (isset($this->statusCode)) {
            header($this->validStatusCode[$this->statusCode]);
        }

        foreach ($this->headers as $header) {
            header($header);
        }

        return $this;
    }



    /**
     * Set the body.
     *
     * @param callable|string $body either a string or a callable that
     *                              can generate the body.
     *
     * @return self
     */
    public function setBody($body)
    {
        if (is_string($body)) {
            $this->body = $body;
        } elseif (is_callable($body)) {
            ob_start();
            $res1 = call_user_func($body);
            $res2 = ob_get_contents();
            $this->body = $res2 . $res1;
            ob_end_clean();
        }
        return $this;
    }



    /**
     * Get the body.
     *
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }



    /**
     * Send response with an optional statuscode.
     *
     * @param integer $statusCode optional statuscode to send.
     *
     * @return self
     */
    public function send($statusCode = null)
    {
        $this->setStatusCode($statusCode);

        if (!headers_sent()) {
            $this->sendHeaders();
        }

        echo $this->getBody();
        return $this;
    }



    /**
     * Send JSON response with an optional statuscode.
     *
     * @param mixed   $data       to be encoded as json.
     * @param integer $statusCode optional statuscode to send.
     *
     * @return self
     */
    public function sendJson($data, $statusCode = null)
    {
        return $this->setStatusCode($statusCode)
                    ->setJsonBody($data)
                    ->send();
    }



    /**
     * Set body with JSON data.
     *
     * @param mixed $data to be encoded as json.
     *
     * @return self
     */
    public function setJsonBody($data)
    {
        $this->addHeader("Content-Type: application/json; charset=utf8");
        $this->setBody(json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
        return $this;
    }



    /**
     * Redirect to another page.
     *
     * @param string $url to redirect to
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.ExitExpression)
     */
    public function redirect($url)
    {
        $this->checkIfHeadersAlreadySent();
        header("Location: " . $url);
        exit;
    }
}