add docblocks to all files, classes, methods and variables

[bdrem.git] / src / bdrem / WebText.php

diff --git a/src/bdrem/WebText.php b/src/bdrem/WebText.php
index fe2e5dcdc1f04b879c38e83c976aa1939afb3eab..51d6d7bc5ca492232b4f57f0a1ca6fe8a581f9bb 100644 (file)
--- a/src/bdrem/WebText.php
+++ b/src/bdrem/WebText.php
@@ -1,14 +1,44 @@
 <?php
+/**
+ * Part of bdrem
+ *
+ * PHP version 5
+ *
+ * @category  Tools
+ * @package   Bdrem
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @copyright 2014 Christian Weiske
+ * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @link      http://cweiske.de/bdrem.htm
+ */
 namespace bdrem;
 
+/**
+ * HTTP user interface that renders a ASCII table
+ *
+ * @category  Tools
+ * @package   Bdrem
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @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 WebText extends Web
 {
-    protected function render($arEvents)
+    /**
+     * Load parameters for the CLI option parser.
+     * Set the default renderer to "console".
+     *
+     * @return \Console_CommandLine CLI option parser
+     */
+    protected function loadParameters()
     {
-        header('Content-type: text/plain; charset=utf-8');
-        $r = new Renderer_Console();
-        $r->ansi = false;
-        echo $r->render($arEvents);
+        $parser = parent::loadParameters();
+        //set default renderer to console
+        $parser->options['renderer']->default = 'console';
+
+        return $parser;
     }
 }
 ?>