cs\Response

Complexity

Total Complexity

31

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	11	3
A	init_with_typical_default_settings()	0	13	1
A	header()	0	11	4
A	redirect()	0	6	1
D	cookie()	0	35	9
A	output_default()	0	8	2
A	output_default_cli()	0	13	4
B	output_default_web()	0	19	7

<?php
/**
 * @package   CleverStyle Framework
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs;
use
	cs\Response\Psr7;
use function
	cli\err,
	cli\out;

class Response {
	use
		Singleton,
		Psr7;
	/**
	 * Protocol, for instance: `HTTP/1.0`, `HTTP/1.1` (default), HTTP/2.0
	 *
	 * @var string
	 */
	public $protocol;
	/**
	 * HTTP status code
	 *
	 * @var int
	 */
	public $code;
	/**
	 * Headers are normalized to lowercase keys with hyphen as separator, for instance: `connection`, `referer`, `content-type`, `accept-language`
	 *
	 * Values might be strings in case of single value or array of strings in case of multiple values with the same field name
	 *
	 * @var string[][]
	 */
	public $headers;
	/**
	 * String body (is used instead of `$this->body_stream` in most cases, ignored if `$this->body_stream` is present)
	 *
	 * @var string
	 */
	public $body;
	/**
	 * Body in form of stream (might be used instead of `$this->body` in some cases, if present, `$this->body` is ignored)
	 *
	 * Stream is read/write
	 *
	 * @var resource
	 */
	public $body_stream;
	/**
	 * Initialize response object with specified data
	 *
	 * @param string               $body
	 * @param null|resource|string $body_stream String, like `php://temp` or resource, like `fopen('php://temp', 'a+b')`, if present, `$body` is ignored
	 * @param string[]|string[][]  $headers     Headers are normalized to lowercase keys with hyphen as separator, for instance: `connection`, `referer`,
	 *                                          `content-type`, `accept-language`; Values might be strings in case of single value or array of strings in case
	 *                                          of multiple values with the same field name
	 * @param int                  $code        HTTP status code
	 * @param string               $protocol    Protocol, for instance: `HTTP/1.0`, `HTTP/1.1` (default), HTTP/2.0
	 *
	 * @return Response
	 */
	function init ($body = '', $body_stream = null, $headers = [], $code = 200, $protocol = 'HTTP/1.1') {
		$this->protocol = $protocol;
		$this->code     = $code;
		$this->headers  = _array($headers);
		$this->body     = $body;
		if ($this->body_stream) {
			fclose($this->body_stream);
		}
		$this->body_stream = is_string($body_stream) ? fopen($body_stream, 'a+b') : $body_stream;
		return $this;
	}
	/**
	 * Initialize with typical default settings (headers `Content-Type`, `Vary` and `X-UA-Compatible`, protocol taken from `cs\Request::$protocol`)
	 *
	 * @return Response
	 */
	function init_with_typical_default_settings () {
		return $this->init(
			'',
			null,
			[
				'Content-Type'    => 'text/html; charset=utf-8',
				'Vary'            => 'Accept-Language,User-Agent,Cookie',
				'X-UA-Compatible' => 'IE=edge' // TODO: I hope some day we'll get rid of this sh*t :(
			],
			200,
			Request::instance()->protocol
		);
	}
	/**
	 * Set raw HTTP header
	 *
	 * @param string $field        Field
	 * @param string $value        Value, empty string will cause header removal
	 * @param bool   $replace      The optional replace parameter indicates whether the header should replace a previous similar header, or add a second header
	 *                             of the same type. By default it will replace
	 *
	 * @return Response
	 */
	function header ($field, $value, $replace = true) {
		$field = strtolower($field);
		if ($value === '') {
			unset($this->headers[$field]);
		} elseif ($replace || !isset($this->headers[$field])) {
			$this->headers[$field] = [$value];
		} else {
			$this->headers[$field][] = $value;
		}
		return $this;
	}
	/**
	 * Make redirect to specified location
	 *
	 * @param string $location
	 * @param int    $code
	 *
	 * @return Response
	 */
	function redirect ($location, $code = 302) {
		$this->header('location', $location);
		$this->code                 = $code;
		Page::instance()->interface = false;
		return $this;
	}
	/**
	 * Function for setting cookies, taking into account cookies prefix. Parameters like in system `setcookie()` function, but `$path`, `$domain` and `$secure`
	 * are skipped, they are detected automatically
	 *
	 * This function have side effect of setting cookie on `cs\Request` object
	 *
	 * @param string $name
	 * @param string $value
	 * @param int    $expire Unix timestamp in seconds
	 * @param bool   $httponly
	 *
	 * @return Response
	 */
	function cookie ($name, $value, $expire = 0, $httponly = false) {
		$Request = Request::instance();
		$Config  = Config::instance();
		$prefix  = '';
		$domain  = explode(':', $Request->host)[0];
		if ($Config) {
			$prefix         = $Config->core['cookie_prefix'];
			$cookie_domains = $Config->core['cookie_domain'];
			$domain         = isset($cookie_domains[$Request->mirror_index]) ? $cookie_domains[$Request->mirror_index] : $cookie_domains[0];
		}
		if ($value === '') {
			unset($Request->cookie[$name], $Request->cookie[$prefix.$name]);
		} else {
			$Request->cookie[$name]         = $value;
			$Request->cookie[$prefix.$name] = $value;
		}
		$header = [
			rawurlencode($prefix.$name).'='.rawurlencode($value),
			'path=/'
		];
		if ($expire || !$value) {
			$header[] = 'expires='.gmdate('D, d-M-Y H:i:s', $expire).' GMT';
		}
		if ($domain) {
			$header[] = "domain=$domain";
		}
		if ($Request->secure) {
			$header[] = 'secure';
		}
		if ($httponly) {
			$header[] = 'HttpOnly';
		}
		$this->header('set-cookie', implode('; ', $header), false);
		return $this;
	}
	/**
	 * Provides default output for all the response data using `header()`, `http_response_code()` and `echo` or `php://output`
	 */
	function output_default () {
		ob_implicit_flush(true);
		if (Request::instance()->cli_path) {
			$this->output_default_cli();
		} else {
			$this->output_default_web();
		}
	}
	protected function output_default_cli () {
		if ($this->code >= 400 && $this->code <= 510) {
			err($this->body);
			exit($this->code % 256);
		}
		if (is_resource($this->body_stream)) {
			$position = ftell($this->body_stream);
			stream_copy_to_stream($this->body_stream, fopen('php://stdout', 'wb'));
			fseek($this->body_stream, $position);
		} else {
			out($this->body);
		}
	}
	protected function output_default_web () {
		foreach ($this->headers ?: [] as $header => $value) {
			$header = ucwords($header, '-');
			foreach ($value as $v) {
				header("$header: $v", false);
			}
		}
		http_response_code($this->code);
		if ($this->code >= 300 && $this->code < 400) {
			return;
		}
		if (is_resource($this->body_stream)) {
			$position = ftell($this->body_stream);
			stream_copy_to_stream($this->body_stream, fopen('php://output', 'wb'));
			fseek($this->body_stream, $position);
		} else {
			echo $this->body;
		}
	}
}