Merge pull request #38 from connectstudios/feature-tree_output

Add Tree output

Author: jlogsdon

README.md

@@ -43,6 +43,15 @@ table rendered for visual display.
 You can also explicitly set the renderer used by calling `cli\Table::setRenderer()` and giving it an instance of one
 of the concrete `cli\table\Renderer` classes.
 
+Tree Display
+------------
+
+ * `cli\Tree::__construct()`
+ * `cli\Tree::setData(array $data)`
+ * `cli\Tree::setRenderer(cli\tree\Renderer $renderer)`
+ * `cli\Tree::render()`
+ * `cli\Tree::display()`
+
 Argument Parser
 ---------------
 

examples/tree.php

@@ -0,0 +1,72 @@
+<?php
+
+require_once 'common.php';
+
+$data = [
+    'Test' => [
+        'Something Cool' => [
+            'This is a 3rd layer',
+        ],
+        'This is a 2nd layer',
+    ],
+    'Other test' => [
+        'This is awesome' => [
+            'This is also cool',
+            'This is even cooler',
+            'Wow like what is this' => [
+                'Awesome eh?',
+                'Totally' => [
+                    'Yep!'
+                ],
+            ],
+        ],
+    ],
+];
+
+printf("ASCII:\n");
+
+/**
+ * ASCII should look something like this:
+ *
+ * -Test
+ * |\-Something Cool
+ * ||\-This is a 3rd layer
+ * |\-This is a 2nd layer
+ * \-Other test
+ *  \-This is awesome
+ *   \-This is also cool
+ *   \-This is even cooler
+ *   \-Wow like what is this
+ *    \-Awesome eh?
+ *    \-Totally
+ *     \-Yep!
+ */
+
+$tree = new \cli\Tree;
+$tree->setData($data);
+$tree->setRenderer(new \cli\tree\Ascii);
+$tree->display();
+
+printf("\nMarkdown:\n");
+
+/**
+ * Markdown looks like this:
+ *
+ * - Test
+ *     - Something Cool
+ *         - This is a 3rd layer
+ *     - This is a 2nd layer
+ * - Other test
+ *     - This is awesome
+ *         - This is also cool
+ *         - This is even cooler
+ *         - Wow like what is this
+ *             - Awesome eh?
+ *             - Totally
+ *                 - Yep!
+ */
+
+$tree = new \cli\Tree;
+$tree->setData($data);
+$tree->setRenderer(new \cli\tree\Markdown(4));
+$tree->display();

lib/cli/Tree.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * PHP Command Line Tools
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.
+ *
+ * @author    Ryan Sullivan <[email protected]>
+ * @copyright 2010 James Logsdom (http://girsbrain.org)
+ * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
+ */
+
+namespace cli;
+
+/**
+ * The `Tree` class is used to display data in a tree-like format.
+ */
+class Tree {
+
+    protected $_renderer;
+    protected $_data = array();
+
+    /**
+     * Sets the renderer used by this tree.
+     *
+     * @param tree\Renderer  $renderer  The renderer to use for output.
+     * @see   tree\Renderer
+     * @see   tree\Ascii
+     * @see   tree\Markdown
+     */
+    public function setRenderer(tree\Renderer $renderer) {
+        $this->_renderer = $renderer;
+    }
+
+    /**
+     * Set the data.
+     * Format:
+     *     [
+     *         'Label' => [
+     *             'Thing' => ['Thing'],
+     *         ],
+     *         'Thing',
+     *     ]
+     * @param array $data
+     */
+    public function setData(array $data)
+    {
+        $this->_data = $data;
+    }
+
+    /**
+     * Render the tree and return it as a string.
+     *
+     * @return string|null
+     */
+    public function render()
+    {
+        return $this->_renderer->render($this->_data);
+    }
+
+    /**
+     * Display the rendered tree
+     */
+    public function display()
+    {
+        echo $this->render();
+    }
+
+}

lib/cli/tree/Ascii.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * PHP Command Line Tools
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.
+ *
+ * @author    Ryan Sullivan <[email protected]>
+ * @copyright 2010 James Logsdom (http://girsbrain.org)
+ * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
+ */
+
+namespace cli\tree;
+
+/**
+ * The ASCII renderer renders trees with ASCII lines.
+ */
+class Ascii extends Renderer {
+
+    /**
+     * @param array $tree
+     * @return string
+     */
+    public function render(array $tree)
+    {
+        $output = '';
+
+        $treeIterator = new \RecursiveTreeIterator(
+            new \RecursiveArrayIterator($tree),
+            \RecursiveTreeIterator::SELF_FIRST
+        );
+
+        foreach ($treeIterator as $val)
+        {
+            $output .= $val . "\n";
+        }
+
+        return $output;
+    }
+
+}

lib/cli/tree/Markdown.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * PHP Command Line Tools
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.
+ *
+ * @author    Ryan Sullivan <[email protected]>
+ * @copyright 2010 James Logsdom (http://girsbrain.org)
+ * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
+ */
+
+namespace cli\tree;
+
+/**
+ * The ASCII renderer renders trees with ASCII lines.
+ */
+class Markdown extends Renderer {
+
+    /**
+     * How many spaces to indent by
+     * @var int
+     */
+    protected $_padding = 2;
+
+    /**
+     * @param int $padding Optional. Default 2.
+     */
+    function __construct($padding = null)
+    {
+        if ($padding)
+        {
+            $this->_padding = $padding;
+        }
+    }
+
+    /**
+     * Renders the tree
+     *
+     * @param array $tree
+     * @param int $level Optional
+     * @return string
+     */
+    public function render(array $tree, $level = 0)
+    {
+        $output = '';
+
+        foreach ($tree as $label => $next)
+        {
+
+            if (is_string($next))
+            {
+                $label = $next;
+            }
+
+            // Output the label
+            $output .= sprintf("%s- %s\n", str_repeat(' ', $level * $this->_padding), $label);
+
+            // Next level
+            if (is_array($next))
+            {
+                $output .= $this->render($next, $level + 1);
+            }
+
+        }
+
+        return $output;
+    }
+
+}

lib/cli/tree/Renderer.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * PHP Command Line Tools
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.
+ *
+ * @author    Ryan Sullivan <[email protected]>
+ * @copyright 2010 James Logsdom (http://girsbrain.org)
+ * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
+ */
+
+namespace cli\tree;
+
+/**
+ * Tree renderers are used to change how a tree is displayed.
+ */
+abstract class Renderer {
+
+    /**
+     * @param array $tree
+     * @return string|null
+     */
+    abstract public function render(array $tree);
+
+}