HummingBirdAnimeClient/src/Ion/View/HttpView.php
2020-08-26 15:25:31 -04:00

204 lines
4.0 KiB
PHP

<?php declare(strict_types=1);
/**
* Hummingbird Anime List Client
*
* An API client for Kitsu to manage anime and manga watch lists
*
* PHP version 7.4
*
* @package HummingbirdAnimeClient
* @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2020 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 5.1
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\Ion\View;
use Aviat\Ion\ViewInterface;
use Laminas\Diactoros\Response;
use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
use Aviat\Ion\Exception\DoubleRenderException;
use Psr\Http\Message\ResponseInterface;
/**
* Base view class for Http output
*/
class HttpView implements ViewInterface{
/**
* HTTP response Object
*
* @var ResponseInterface
*/
public ResponseInterface $response;
/**
* If the view has sent output via
* __toString or send method
*
* @var boolean
*/
protected bool $hasRendered = FALSE;
/**
* Response mime type
*
* @var string
*/
protected string $contentType = '';
/**
* Constructor.
*/
public function __construct()
{
$this->response = new Response();
}
/**
* Send output to client
*/
public function __destruct()
{
if ( ! $this->hasRendered)
{
$this->send();
}
}
/**
* Return rendered output as string. Renders the view,
* and any attempts to call again will result in a DoubleRenderException
*
* @throws DoubleRenderException
* @return string
*/
public function __toString(): string
{
if ($this->hasRendered)
{
throw new DoubleRenderException();
}
$this->hasRendered = TRUE;
return $this->getOutput();
}
/**
* Add an http header
*
* @param string $name
* @param string|string[] $value
* @return HttpView
*/
public function addHeader(string $name, $value): self
{
$this->response = $this->response->withHeader($name, $value);
return $this;
}
/**
* Set the output string
*
* @param mixed $string
* @return HttpView
*/
public function setOutput($string): self
{
$this->response->getBody()->write($string);
return $this;
}
/**
* Append additional output.
*
* @param string $string
* @return HttpView
*/
public function appendOutput(string $string): self
{
return $this->setOutput($string);
}
/**
* Get the current output as a string. Does not
* render view or send headers.
*
* @return string
*/
public function getOutput(): string
{
return (string)$this->response->getBody();
}
/**
* Do a redirect
*
* @param string $url
* @param int $code
* @param array $headers
* @throws \InvalidArgumentException
* @return self
*/
public function redirect(string $url, int $code = 302, array $headers = []): self
{
$this->response = new Response\RedirectResponse($url, $code, $headers);
return $this;
}
/**
* Set the status code of the request
*
* @param int $code
* @throws \InvalidArgumentException
* @return HttpView
*/
public function setStatusCode(int $code): self
{
$this->response = $this->response->withStatus($code)
->withProtocolVersion('1.1');
return $this;
}
/**
* Send output to client. As it renders the view,
* any attempt to call again will result in a DoubleRenderException.
*
* @throws DoubleRenderException
* @throws \InvalidArgumentException
* @return void
*/
public function send(): void
{
$this->output();
}
/**
* Send the appropriate response
*
* @throws DoubleRenderException
* @throws \InvalidArgumentException
* @return void
*/
protected function output(): void
{
if ($this->hasRendered)
{
throw new DoubleRenderException();
}
$this->response = $this->response
->withHeader('Content-type', "{$this->contentType};charset=utf-8")
->withHeader('X-Content-Type-Options', 'nosniff')
->withHeader('X-XSS-Protection', '1;mode=block')
->withHeader('X-Frame-Options', 'SAMEORIGIN');
(new SapiEmitter())->emit($this->response);
$this->hasRendered = TRUE;
}
}