ion/src/Ion/ViewInterface.php

62 lines
1.2 KiB
PHP

<?php
/**
* Ion
*
* Building blocks for web development
*
* @package Ion
* @author Timothy J. Warren
* @copyright Copyright (c) 2015 - 2016
* @license MIT
*/
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();
/**
* Set the output string
*
* @param string $string
* @return ViewInterface
*/
public function setOutput($string);
/**
* Append additional output.
*
* @param string $string
* @return ViewInterface
*/
public function appendOutput($string);
/**
* Get the current output as a string. Does not
* render view or send headers.
*
* @return string
*/
public function getOutput();
/**
* 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();
}