Phile\Core\Response

Complexity

Total Complexity

14

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

82.5%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	createResponse()	0	4	1
A	createHtmlResponse()	0	4	1
A	createRedirectResponse()	0	4	1
A	redirect()	0	8	1
A	setBody()	0	5	1
A	setCharset()	0	5	1
A	setHeader()	0	8	2
A	setStatusCode()	0	5	1
A	send()	0	10	2
A	stop()	0	4	1
A	outputHeader()	0	6	2

<?php

/**
 * the Response class
 */

namespace Phile\Core;

use Interop\Http\Factory\ResponseFactoryInterface;
use Zend\Diactoros\Response\HtmlResponse;
use Zend\Diactoros\Response\RedirectResponse;
use Zend\Diactoros\Response as Psr7Response;

/**
 * the Response class is responsible for sending a HTTP response to the client
 *
 * Response is chainable and can be used anywhere:
 *
 *     (new Respose)->setBody('Hello World')->send();
 *
 * After send() Phile is terminated.
 *
 * @author  PhileCMS
 * @link    https://philecms.com
 * @license http://opensource.org/licenses/MIT
 * @package Phile
 */
class Response implements ResponseFactoryInterface
{
    /**
     * @var string HTTP body
     */
    protected $body = '';

    /**
     * @var string charset
     */
    protected $charset = 'utf-8';

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

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

    /**
     * Creates a PSR-7 response
     */
    public function createResponse($code = 200)
    {
        return new Psr7Response('php://memory', $code);
    }

    /**
     * Creates PSR-7 HTML response
     */
    public function createHtmlResponse($body, $code = 200)
    {
        return new HtmlResponse($body, $code);
    }

    /**
     * Creates PSR-7 redirect response
     */
    public function createRedirectResponse($url, $code = 302)
    {
        return new RedirectResponse($url, $code);
    }

    /**
     * redirect to another URL
     *
     * @param string $url        URL
     * @param int    $statusCode
     */
    public function redirect($url, $statusCode = 302)
    {
        $this->setStatusCode($statusCode)
            ->setHeader('Location', $url, true)
            ->setBody('')
            ->send()
            ->stop();
    }

    /**
     * set the response body
     *
     * @param  $body
     * @return $this
     */
    public function setBody($body)
    {
        $this->body = $body;
        return $this;
    }

    /**
     * set the response character-set
     *
     * @param  $charset
     * @return $this
     */
    public function setCharset($charset)
    {
        $this->charset = $charset;
        return $this;
    }

    /**
     * set a response HTTP-header
     *
     * @param  string $key
     * @param  string $value
     * @param  bool   $clear clear out any existing headers
     * @return $this
     */
    public function setHeader($key, $value, $clear = false)
    {
        if ($clear) {
            $this->headers = [];
        }
        $this->headers[$key] = "$key: $value";
        return $this;
    }

    /**
     * set the response HTTP status code
     *
     * @param  $code
     * @return $this
     */
    public function setStatusCode($code)
    {
        $this->statusCode = $code;
        return $this;
    }

    /**
     * sends the HTTP response
     *
     * @return $this
     */
    public function send()
    {
        if (!isset($this->headers['Content-Type'])) {
            $this->setHeader('Content-Type', 'text/html; charset=' . $this->charset);
        }
        $this->outputHeader();
        http_response_code($this->statusCode);
        echo $this->body;
        return $this;
    }

    /**
     * helper for easy testing
     */
    public function stop()
    {
        die();
    }

    /**
     * output all set response headers
     */
    protected function outputHeader()
    {
        foreach ($this->headers as $header) {
            header($header);
        }
    }
}