ion/src/ViewInterface.php

66 lines
1.4 KiB
PHP
Raw Normal View History

2016-10-13 13:11:22 -04:00
<?php declare(strict_types=1);
2016-08-26 17:21:50 -04:00
/**
* Ion
*
* Building blocks for web development
*
2016-10-13 13:11:22 -04:00
* PHP version 7
*
2016-08-26 17:21:50 -04:00
* @package Ion
* @author Timothy J. Warren <tim@timshomepage.net>
2017-02-22 15:42:09 -05:00
* @copyright 2015 - 2017 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2017-02-22 15:42:09 -05:00
* @version 2.0.0
* @link https://git.timshomepage.net/timw4mail/ion
2016-08-26 17:21:50 -04:00
*/
namespace Aviat\Ion;
use Aviat\Ion\Exception\DoubleRenderException;
/**
* View Interface abstracting a Response
*/
interface ViewInterface {
/**
* 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;
2016-08-26 17:21:50 -04:00
/**
* Set the output string
*
* @param mixed $string
2016-08-26 17:21:50 -04:00
* @return ViewInterface
*/
public function setOutput($string): ViewInterface;
2016-08-26 17:21:50 -04:00
/**
* Append additional output.
*
* @param string $string
* @return ViewInterface
*/
public function appendOutput(string $string): ViewInterface;
2016-08-26 17:21:50 -04:00
/**
* Get the current output as a string. Does not
* render view or send headers.
*
* @return string
*/
public function getOutput(): string;
2016-08-26 17:21:50 -04:00
/**
* Send output to client. As it renders the view,
* any attempt to call again will result in a DoubleRenderException.
*
* @throws DoubleRenderException
* @return void
*/
public function send();
}