Initial support for the interactive console line manual.

Author: Slavey Karadzhov

.gitignore

@@ -1,3 +1,7 @@
 composer.phar
 composer.lock
 vendor/
+.project
+.buildpath
+.settings
+php-cs-fixer.phar

composer.json

@@ -23,7 +23,8 @@
 		"php" : ">=5.3.3",
 		"openlss/lib-array2xml" : "dev-master",
 		"zenddevops/webapi" : "dev-master",
-                "mustangostang/spyc" : "dev-master"
+		"mustangostang/spyc" : "dev-master",
+		"slk/icm"            : "dev-master"
 	},
 	"require-dev" : {
 		"phpunit/phpunit" : "3.7.*",

module/Client/config/module.config.php

@@ -258,5 +258,10 @@
            'template_path_stack' => array(
                __DIR__ .'/../views/',
             )
+        ),
+        'view_helpers' => array(
+            'invokables' => array(
+                'figlet' => 'Slk\View\Helper\Figlet',
+             )
         )
 );

module/Client/src/Client/Controller/ManualController.php

@@ -1,29 +1,70 @@
 <?php
 namespace Client\Controller;
-use Zend\Mvc\Controller\AbstractActionController;
+
 use Zend\View\Model\ViewModel;
 use Zend\Stdlib\ResponseInterface as Response;
 use Zend\Stdlib\RequestInterface as Request;
-use Zend\View\Renderer\PhpRenderer;
+use Zend\Stdlib\DispatchableInterface;
+use Zend\Mvc\InjectApplicationEventInterface;
+use Zend\EventManager\EventInterface as Event;
+use Zend\ServiceManager\ServiceLocatorAwareInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+use Slk\View\ICMRenderer;
 
 /**
  * Manual Pages Controller
  */
-class ManualController extends AbstractActionController
+class ManualController implements DispatchableInterface,
+                                  ServiceLocatorAwareInterface,
+                                  InjectApplicationEventInterface
 {
+    protected $event;
+    protected $serviceLocator;
+
     public function dispatch(Request $request, Response $response = null)
     {
         $serviceManager = $this->getServiceLocator();
         $routeMatch = $this->getEvent()->getRouteMatch();
         $viewModel = new ViewModel();
         $viewModel->setTemplate('client/manual/'.strtolower($routeMatch->getParam('action')));
-        if($serviceManager->has('viewrenderer')) {
-          $renderer = $serviceManager->get('viewrenderer');
-        } else {
-            $renderer = new PhpRenderer();
-            $renderer->setResolver($serviceManager->get('ViewResolver'));
-        }
-
-        return $response->setContent($renderer->render($viewModel));
+        $renderer = new ICMRenderer();
+        $renderer->setConsoleAdapter($serviceManager->get('console'));
+        $renderer->setResolver($serviceManager->get('ViewResolver'));
+        $renderer->setHelperPluginManager($serviceManager->get('ViewHelperManager'));
+
+        $renderer->render($viewModel);
+    }
+    /* (non-PHPdoc)
+     * @see \Zend\Mvc\InjectApplicationEventInterface::setEvent()
+     */
+    public function setEvent(Event $event)
+    {
+        $this->event = $event;
+    }
+
+    /* (non-PHPdoc)
+     * @see \Zend\Mvc\InjectApplicationEventInterface::getEvent()
+     */
+    public function getEvent()
+    {
+        return $this->event;
+    }
+
+    /* (non-PHPdoc)
+     * @see \Zend\ServiceManager\ServiceLocatorAwareInterface::setServiceLocator()
+     */
+    public function setServiceLocator(ServiceLocatorInterface $serviceLocator)
+    {
+        $this->serviceLocator = $serviceLocator;
     }
+
+    /* (non-PHPdoc)
+     * @see \Zend\ServiceManager\ServiceLocatorAwareInterface::getServiceLocator()
+     */
+    public function getServiceLocator()
+    {
+        return $this->serviceLocator;
+    }
+
 }

module/Client/views/client/manual/gettingstarted.phtml

@@ -1 +1,68 @@
-This is the getting started ...
+[[[
+   ____      _   _   _               ____  _             _           _
+  / ___| ___| |_| |_(_)_ __   __ _  / ___|| |_ __ _ _ __| |_ ___  __| |
+ | |  _ / _ \ __| __| | '_ \ / _` | \___ \| __/ _` | '__| __/ _ \/ _` |
+ | |_| |  __/ |_| |_| | | | | (_| |  ___) | || (_| | |  | ||  __/ (_| |
+  \____|\___|\__|\__|_|_| |_|\__, | |____/ \__\__,_|_|   \__\___|\__,_|
+                             |___/
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+]]]
+>>>
+
+Welcome to $script getting started tutorial.
+
+To get more information about the different commands available in this tool type:
+$script --help.
+
+Type below the command argument as given above to see a list of available command groups.
+>$_
+== --help
+=> args
+$_ $args
+
+The result from this command would be....
+------
+
+$result
+
+------
+>>>
+Now if you want to see commands in one specific group you have to type command:<group-name>.
+For example in order to get a list of all codetracing commands you have to type:
+
+$script command:codetracing
+
+Can you type below the argument to show all commands in the group "high-level"?
+>$_
+== command:high-level
+=> args
+
+$_ $args
+
+Let's see what commands are in this group:
+$result
+
+>>>$
+If you know a command but do not know its parameters then you can type:
+$script <command> --help.
+
+Now check what are the arguments for the addTarget command.
+
+>$_
+== /^\s*addTarget\s+\-\-help$/
+=== addTarget --help
+=> args
+
+$_ $args
+
+The result from this command would be....
+------
+
+$result
+
+------
+
+[[[
+    Adding Targets
+    ~~~~~~~~~~~~~~
+]]]