phacil-framework/system/engine/response.php

<?php
/*
 * Copyright © 2021 ExacTI Technology Solutions. All rights reserved.
 * GPLv3 General License.
 * https://exacti.com.br
 * Phacil PHP Framework - https://github.com/exacti/phacil-framework
 */

namespace Phacil\Framework;

/** 
 * HTTP response class.
 * 
 * @since 0.0.1
 * 
 * @package Phacil\Framework
 * @api
 */
final class Response {

	/**
	 * 
	 * @var array
	 */
	private $headers = array(); 

	/**
	 * 
	 * @var int
	 */
	private $level = 0;

	private $output;
	
	/**
	 * Add a HTTP header, it's must be a one string or two string args.
	 * 
	 * @param string $header The all entire header or just a key
	 * @param string|null $content [optional] An content value header
	 * @return void 
	 */
	public function addHeader($header, $content = null) {
		if($content){
			$this->headers[$header] = $content;
		} else {
			$head = explode(':', $header, 2);
			$this->headers[$head['0']] = isset($head[1]) ? $head[1]: false;
		}
	}

	/**
	 * Send redirect HTTP header to specified URL
	 * 
	 * @param string $url 
	 * @param int $status 
	 * @return never 
	 */
	public function redirect($url, $status = 302) 
	{
		header('Status: ' . $status);
		header('Location: ' . $url);
		exit;
	}
	
	/**
	 * @param int $level 
	 * @return void 
	 */
	public function setCompression($level) {
		$this->level = $level;
	}
		
	/**
	 * @param mixed $output 
	 * @param bool $isJSON 
	 * @param int $HTTPCODE 
	 * @param string|null $HTTPDESC 
	 * @return void 
	 */
	public function setOutput($output, $isJSON = false, $HTTPCODE = 0, $HTTPDESC = null) {

		if($isJSON)
			$this->isJSON();

		if($HTTPCODE !== 0)
			$this->code($HTTPCODE, $HTTPDESC);

		$this->output = $output;
	}

	public function setParcialOutput($output) {
		$this->output .= ($output ?: '');
	}

	/**
	 * @param mixed $data 
	 * @param int $level 
	 * @return string|false 
	 */
	private function compress($data, $level = 0) {
		if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false)) {
			$encoding = 'gzip';
		} 

		if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'x-gzip') !== false)) {
			$encoding = 'x-gzip';
		}

		if (!isset($encoding)) {
			return $data;
		}

		if (!extension_loaded('zlib') || ini_get('zlib.output_compression')) {
			return $data;
		}

		if (headers_sent()) {
			return $data;
		}

		if (connection_status()) { 
			return $data;
		}
		
		$this->addHeader('Content-Encoding: ' . $encoding);

		return gzencode($data, (int)$level);
	}

	/** @return void  */
	public function output() {
		if ($this->output) {
			if ($this->level) {
				$ouput = $this->compress($this->output, $this->level);
			} else {
				$ouput = $this->output;
			}	
				
			if (!headers_sent()) {
				foreach ($this->headers as $key => $header) {
					try {
						if(!$header)
							header($key, true);
						else 
							header($key.": ".$header, true);

					} catch (\Exception $th) {
						//throw $th;
						throw new Exception("Error Processing Header ".$key, 1, $th);
					}
					
				}
			} else {
				throw new Exception("Error Processing Headers: Header or Content has been sent", 1);
			}
			
			echo $ouput;
		}
	}

	/** @return void  */
	public function isJSON() {
		$this->addHeader('Content-Type', 'application/json');
	}

	/**
	 * @param int $code 
	 * @param string|null $description 
	 * @return void 
	 */
	public function code($code, $description = null){
		$this->addHeader("HTTP/1.1 ".$code.(($description) ? " ". $description : ""));
        $this->addHeader("Status: ".$code."");
	}

	/**
	 * Clean all seted headers
	 * @return $this 
	 */
	public function clearHeaders() {
		$this->headers = [];
		return $this;
	}
}