<?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;
+/**
+ * Generic user interface class
+ *
+ * @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
+ */
abstract class UserInterface
{
+ /**
+ * Configuration
+ * @var Config
+ */
protected $config;
+ /**
+ * Start the user interface, load config, parse and render events.
+ *
+ * @return void
+ */
public function run()
{
try {
if (!$this->config->cfgFileExists) {
throw new \Exception(
"No config file found. Looked at the following places:\n"
- . '- ' . implode ("\n- ", $this->config->cfgFiles)
+ . '- ' . implode("\n- ", $this->config->cfgFiles)
);
}
}
}
+ /**
+ * Load parameters for the CLI option parser.
+ *
+ * @return \Console_CommandLine CLI option parser
+ */
protected function loadParameters()
{
$parser = new \Console_CommandLine();
return $parser;
}
- protected function parseParameters($parser)
+ /**
+ * Let the CLI option parser parse the options.
+ *
+ * @param object $parser Option parser
+ *
+ * @return object Parsed command line parameters
+ */
+ protected function parseParameters(\Console_CommandLine $parser)
{
try {
$result = $parser->parse();
$this->config->renderer = $result->options['renderer'];
$this->config->stopOnEmpty = $result->options['stopOnEmpty'];
$this->config->setDate($result->options['date']);
+ if (isset($result->options['ansi'])) {
+ $this->config->ansi = $result->options['ansi'];
+ }
return $result;
} catch (\Exception $exc) {
$this->preRenderParameterError();
}
}
+ /**
+ * Output the events
+ *
+ * @param array $arEvents Event objects to render
+ *
+ * @return void
+ */
protected function render($arEvents)
{
$r = $this->getRenderer();
$r->renderAndOutput($arEvents);
}
+ /**
+ * Load the configured renderer
+ *
+ * @return Renderer Renderer instance
+ */
protected function getRenderer()
{
$renderer = ucfirst($this->config->renderer);
return new $class();
}
+ /**
+ * Handle any commands given on the CLI
+ *
+ * @param object $res Command line parameters and options
+ *
+ * @return void
+ */
protected function handleCommands($res)
{
}
+ /**
+ * Do something before a parameter parsing error is shown
+ *
+ * @return void
+ */
protected function preRenderParameterError()
{
}