From 6032c11d7a88651d85154ffe835a26b3f569c893 Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Thu, 20 Mar 2014 17:03:06 +0100 Subject: add docblocks to all files, classes, methods and variables --- src/bdrem/Renderer/Html.php | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) (limited to 'src/bdrem/Renderer/Html.php') diff --git a/src/bdrem/Renderer/Html.php b/src/bdrem/Renderer/Html.php index 637a838..428f819 100644 --- a/src/bdrem/Renderer/Html.php +++ b/src/bdrem/Renderer/Html.php @@ -1,22 +1,64 @@ + * @copyright 2014 Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @link http://cweiske.de/bdrem.htm + */ namespace bdrem; +/** + * HTML page renderer. Renders a full HTML page. + * + * @category Tools + * @package Bdrem + * @author Christian Weiske + * @copyright 2014 Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @version Release: @package_version@ + * @link http://cweiske.de/bdrem.htm + */ class Renderer_Html extends Renderer { + /** + * HTTP content type + * @var string + */ protected $httpContentType = 'application/xhtml+xml; charset=utf-8'; + /** + * Send out HTTP headers when nothing shall be outputted. + * + * @return void + */ public function handleStopOnEmpty() { header('HTTP/1.0 204 No Content'); } + /** + * Generate a HTML page with the given events. + * + * @param array $arEvents Events to display on the HTML page + * + * @return string HTML code + * + * @see Renderer_HtmlTable + */ public function render($arEvents) { $tr = new Renderer_HtmlTable(); $table = $tr->render($arEvents); $s = << - + bdrem -- cgit v1.2.3