mirror of
https://github.com/Karaka-Management/phpOMS.git
synced 2026-01-11 17:58:41 +00:00
403 lines
8.7 KiB
PHP
403 lines
8.7 KiB
PHP
<?php
|
|
/**
|
|
* Orange Management
|
|
*
|
|
* PHP Version 7.0
|
|
*
|
|
* @category TBD
|
|
* @package TBD
|
|
* @author OMS Development Team <dev@oms.com>
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
* @copyright 2013 Dennis Eichhorn
|
|
* @license OMS License 1.0
|
|
* @version 1.0.0
|
|
* @link http://orange-management.com
|
|
*/
|
|
namespace phpOMS\Message\Http;
|
|
|
|
use phpOMS\Contract\ArrayableInterface;
|
|
use phpOMS\Contract\RenderableInterface;
|
|
use phpOMS\Message\ResponseAbstract;
|
|
use phpOMS\Model\Html\Head;
|
|
use phpOMS\Utils\ArrayUtils;
|
|
use phpOMS\DataStorage\Cookie\CookieJar;
|
|
use phpOMS\DataStorage\Session\HttpSession;
|
|
|
|
/**
|
|
* Response class.
|
|
*
|
|
* @category Framework
|
|
* @package phpOMS\Response
|
|
* @author OMS Development Team <dev@oms.com>
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
* @license OMS License 1.0
|
|
* @link http://orange-management.com
|
|
* @since 1.0.0
|
|
*/
|
|
class Response extends ResponseAbstract implements RenderableInterface
|
|
{
|
|
|
|
/**
|
|
* Header.
|
|
*
|
|
* @var string[][]
|
|
* @since 1.0.0
|
|
*/
|
|
private $header = [];
|
|
|
|
/**
|
|
* html head.
|
|
*
|
|
* @var Head
|
|
* @since 1.0.0
|
|
*/
|
|
private $head = null;
|
|
|
|
private static $isLocked = false;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->setHeader('Content-Type', 'text/html; charset=utf-8');
|
|
$this->head = new Head();
|
|
}
|
|
|
|
/**
|
|
* Push header by ID.
|
|
*
|
|
* @param mixed $name Header ID
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function pushHeaderId($name)
|
|
{
|
|
if(self::$isLocked) {
|
|
throw new \Exception('Already locked');
|
|
}
|
|
|
|
foreach ($this->header[$name] as $key => $value) {
|
|
header($name, $value);
|
|
}
|
|
|
|
$this->lock();
|
|
}
|
|
|
|
/**
|
|
* Remove header by ID.
|
|
*
|
|
* @param int $key Header key
|
|
*
|
|
* @return bool
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function removeHeader(int $key) : bool
|
|
{
|
|
if(self::$isLocked) {
|
|
throw new \Exception('Already locked');
|
|
}
|
|
|
|
if (isset($this->header[$key])) {
|
|
unset($this->header[$key]);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Generate header automatically based on code.
|
|
*
|
|
* @param int $code HTTP status code
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function generateHeader(int $code)
|
|
{
|
|
if ($code === 403) {
|
|
$this->generate403();
|
|
} elseif ($code === 406) {
|
|
$this->generate406();
|
|
} elseif ($code === 503) {
|
|
$this->generate503();
|
|
}
|
|
}
|
|
|
|
private function generate403()
|
|
{
|
|
$this->setHeader('HTTP', 'HTTP/1.0 403 Forbidden');
|
|
$this->setHeader('Status', 'Status: HTTP/1.0 403 Forbidden');
|
|
}
|
|
|
|
private function generate406()
|
|
{
|
|
$this->setHeader('HTTP', 'HTTP/1.0 406 Not acceptable');
|
|
$this->setHeader('Status', 'Status: 406 Not acceptable');
|
|
}
|
|
|
|
private function generate503()
|
|
{
|
|
$this->setHeader('HTTP', 'HTTP/1.0 503 Service Temporarily Unavailable');
|
|
$this->setHeader('Status', 'Status: 503 Service Temporarily Unavailable');
|
|
$this->setHeader('Retry-After', 'Retry-After: 300');
|
|
}
|
|
|
|
/**
|
|
* Set response.
|
|
*
|
|
* @param string $response Response to set
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function setResponse(string $response)
|
|
{
|
|
$this->response = $response;
|
|
}
|
|
|
|
/**
|
|
* Push a specific response ID.
|
|
*
|
|
* @param int $id Response ID
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function pushResponseId(int $id)
|
|
{
|
|
ob_start();
|
|
echo $this->response[$id];
|
|
ob_end_flush();
|
|
}
|
|
|
|
/**
|
|
* Generate response.
|
|
*
|
|
* @return \Iterator
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function getYield() : \Iterator
|
|
{
|
|
yield $this->head->render();
|
|
|
|
foreach ($this->response as $key => $response) {
|
|
yield $response;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Push all headers.
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function pushHeader()
|
|
{
|
|
if(self::$isLocked) {
|
|
throw new \Exception('Already locked');
|
|
}
|
|
|
|
foreach ($this->header as $name => $arr) {
|
|
foreach ($arr as $ele => $value) {
|
|
header($name . ': ' . $value);
|
|
}
|
|
}
|
|
|
|
$this->lock();
|
|
}
|
|
|
|
/**
|
|
* Remove response by ID.
|
|
*
|
|
* @param int $id Response ID
|
|
*
|
|
* @return bool
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function remove(int $id) : bool
|
|
{
|
|
if(self::$isLocked) {
|
|
throw new \Exception('Already locked');
|
|
}
|
|
|
|
if (isset($this->response[$id])) {
|
|
unset($this->response[$id]);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getHead()
|
|
{
|
|
return $this->head;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getProtocolVersion() : string
|
|
{
|
|
return '1.0';
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getHeaders() : array
|
|
{
|
|
return $this->header;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function hasHeader(string $name) : bool
|
|
{
|
|
return array_key_exists($name, $this->header);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getBody() : string
|
|
{
|
|
return $this->render();
|
|
}
|
|
|
|
/**
|
|
* Generate response.
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws \Exception
|
|
*
|
|
* @since 1.0.0
|
|
* @author Dennis Eichhorn <d.eichhorn@oms.com>
|
|
*/
|
|
public function render() : string
|
|
{
|
|
$render = $this->head->render();
|
|
|
|
// todo: fix api return
|
|
// right now it is_object hence not printing the request key => object and only object->render();
|
|
// this can't be changed easily since view uses this as well and this mustn't print a key. maybe view instanceof View?
|
|
foreach ($this->response as $key => $response) {
|
|
if (is_object($response)) {
|
|
$render .= $response->render();
|
|
} elseif (is_string($response) || is_numeric($response)) {
|
|
$render .= $response;
|
|
} elseif (is_array($response)) {
|
|
$render .= json_encode($response);
|
|
// TODO: remove this. This should never happen since then someone forgot to set the correct header. it should be json header!
|
|
} else {
|
|
throw new \Exception('Wrong response type');
|
|
}
|
|
}
|
|
|
|
return $render;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function toCsv() : string
|
|
{
|
|
return ArrayUtils::arrayToCSV($this->toArray());
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function toArray() : array
|
|
{
|
|
$arr = [];
|
|
|
|
foreach ($this->response as $key => $response) {
|
|
if ($response instanceof ArrayableInterface) {
|
|
$arr = ArrayUtils::setArray($key, $arr, $response->toArray(), ':');
|
|
} else {
|
|
$arr = ArrayUtils::setArray($key, $arr, $response, ':');
|
|
}
|
|
}
|
|
|
|
return $arr;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getReasonPhrase() : string
|
|
{
|
|
return $this->getHeader('Status');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getHeader(string $name)
|
|
{
|
|
if (isset($this->header[$name])) {
|
|
return $this->header[$name];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setHeader($key, string $header, bool $overwrite = false) : bool
|
|
{
|
|
if(self::$isLocked) {
|
|
throw new \Exception('Already locked');
|
|
}
|
|
|
|
if (!$overwrite && isset($this->header[$key])) {
|
|
return false;
|
|
} elseif ($overwrite) {
|
|
unset($this->header[$key]);
|
|
}
|
|
|
|
if (!isset($this->header[$key])) {
|
|
$this->header[$key] = [];
|
|
}
|
|
|
|
$this->header[$key][] = $header;
|
|
|
|
return true;
|
|
}
|
|
|
|
private function lock()
|
|
{
|
|
CookieJar::lock();
|
|
HttpSession::lock();
|
|
self::$isLocked = true;
|
|
}
|
|
}
|