Split item with builder

examples/split-item.php

@@ -0,0 +1,35 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$itemCallable = function (CliMenu $menu) {
+    echo $menu->getSelectedItem()->getText();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setWidth(150)
+    ->addSplitItem()
+        ->addSubMenu('Sub Menu on a split item')
+            ->setTitle('Behold the awesomeness')
+            ->addItem('This is awesome', function() { print 'Yes!'; })
+            ->addSplitItem()
+                ->addItem('Split Item 1', function() { print 'Item 1!'; })
+                ->addItem('Split Item 2', function() { print 'Item 2!'; })
+                ->addItem('Split Item 3', function() { print 'Item 3!'; })
+                ->addSubMenu('Split Item Nested Sub Menu')
+                    ->addItem('One', function() { print 'One!'; })
+                    ->addItem('Two', function() { print 'Two!'; })
+                    ->addItem('Three', function() { print 'Three!'; })
+                    ->end()
+                ->end()
+            ->end()
+        ->addItem('Item 2', $itemCallable)
+        ->addStaticItem('Item 3 - Static')
+        ->addItem('Item 4', $itemCallable)
+        ->end()
+    ->build();
+
+$menu->open();

src/Builder.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpSchool\CliMenu;
+
+use PhpSchool\Terminal\Terminal;
+
+/**
+ * @author Aydin Hassan <aydin@hotmail.co.uk>
+ */
+interface Builder
+{
+    public function getTerminal() : Terminal;
+
+    public function end() : ?Builder;
+
+    public function getMenuStyle() : MenuStyle;
+}

src/BuilderUtils.php

@@ -0,0 +1,109 @@
+<?php
+
+namespace PhpSchool\CliMenu;
+
+use PhpSchool\CliMenu\MenuItem\LineBreakItem;
+use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
+use PhpSchool\CliMenu\MenuItem\SelectableItem;
+use PhpSchool\CliMenu\MenuItem\StaticItem;
+use RuntimeException;
+
+/**
+ * @author Aydin Hassan <aydin@hotmail.co.uk>
+ */
+trait BuilderUtils
+{
+    /**
+     * @var null|Builder
+     */
+    private $parent;
+
+    /**
+     * @var self[]
+     */
+    private $subMenuBuilders = [];
+
+    /**
+     * @var CliMenu[]
+     */
+    private $subMenus = [];
+
+    /**
+     * @var array
+     */
+    private $menuItems = [];
+
+    public function addItem(
+        string $text,
+        callable $itemCallable,
+        bool $showItemExtra = false,
+        bool $disabled = false
+    ) : self {
+        $this->menuItems[] = new SelectableItem($text, $itemCallable, $showItemExtra, $disabled);
+
+        return $this;
+    }
+
+    public function addStaticItem(string $text) : self
+    {
+        $this->menuItems[] = new StaticItem($text);
+
+        return $this;
+    }
+
+    public function addLineBreak(string $breakChar = ' ', int $lines = 1) : self
+    {
+        $this->menuItems[] = new LineBreakItem($breakChar, $lines);
+
+        return $this;
+    }
+
+    /**
+     * Add a submenu with a name. The name will be displayed as the item text
+     * in the parent menu.
+     */
+    public function addSubMenu(string $name, CliMenuBuilder $subMenuBuilder = null) : Builder
+    {
+        $this->menuItems[]  = $id = 'submenu-placeholder-' . $name;
+
+        if (null === $subMenuBuilder) {
+            $this->subMenuBuilders[$id] = new CliMenuBuilder($this);
+            return $this->subMenuBuilders[$id];
+        }
+
+        $this->subMenuBuilders[$id] = $subMenuBuilder;
+        return $this;
+    }
+
+    private function buildSubMenus(array $items) : array
+    {
+        return array_map(function ($item) {
+            if (!is_string($item) || 0 !== strpos($item, 'submenu-placeholder-')) {
+                return $item;
+            }
+
+            $menuBuilder           = $this->subMenuBuilders[$item];
+            $this->subMenus[$item] = $menuBuilder->build();
+
+            return new MenuMenuItem(
+                substr($item, \strlen('submenu-placeholder-')),
+                $this->subMenus[$item],
+                $menuBuilder->isMenuDisabled()
+            );
+        }, $items);
+    }
+
+    /**
+     * Return to parent builder
+     *
+     * @throws RuntimeException
+     */
+    public function end() : ?Builder
+    {
+        if (null === $this->parent) {
+            throw new RuntimeException('No parent builder to return to');
+        }
+
+        return $this->parent;
+    }
+}

src/CliMenu.php

@@ -12,6 +12,7 @@
 use PhpSchool\CliMenu\Input\Text;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
+use PhpSchool\CliMenu\MenuItem\SplitItem;
 use PhpSchool\CliMenu\MenuItem\StaticItem;
 use PhpSchool\CliMenu\Dialogue\Confirm;
 use PhpSchool\CliMenu\Dialogue\Flash;
@@ -256,7 +257,12 @@ private function display() : void
             switch ($char->getControl()) {
                 case InputCharacter::UP:
                 case InputCharacter::DOWN:
-                    $this->moveSelection($char->getControl());
+                    $this->moveSelectionVertically($char->getControl());
+                    $this->draw();
+                    break;
+                case InputCharacter::LEFT:
+                case InputCharacter::RIGHT:
+                    $this->moveSelectionHorizontally($char->getControl());
                     $this->draw();
                     break;
                 case InputCharacter::ENTER:
@@ -269,11 +275,11 @@ private function display() : void
     /**
      * Move the selection in a given direction, up / down
      */
-    protected function moveSelection(string $direction) : void
+    protected function moveSelectionVertically(string $direction) : void
     {
-        do {
-            $itemKeys = array_keys($this->items);
+        $itemKeys = array_keys($this->items);
 
+        do {
             $direction === 'UP'
                 ? $this->selectedItem--
                 : $this->selectedItem++;
@@ -282,15 +288,65 @@ protected function moveSelection(string $direction) : void
                 $this->selectedItem  = $direction === 'UP'
                     ? end($itemKeys)
                     : reset($itemKeys);
-            } elseif ($this->getSelectedItem()->canSelect()) {
-                return;
             }
-        } while (!$this->getSelectedItem()->canSelect());
+        } while (!$this->canSelect());
     }
 
+    /**
+     * Move the selection in a given direction, left / right
+     */
+    protected function moveSelectionHorizontally(string $direction) : void
+    {
+        if (!$this->items[$this->selectedItem] instanceof SplitItem) {
+            return;
+        }
+
+        /** @var SplitItem $item */
+        $item = $this->items[$this->selectedItem];
+        $itemKeys = array_keys($item->getItems());
+        $selectedItemIndex = $item->getSelectedItemIndex();
+
+        do {
+            $direction === 'LEFT'
+                ? $selectedItemIndex--
+                : $selectedItemIndex++;
+
+            if (!array_key_exists($selectedItemIndex, $item->getItems())) {
+                $selectedItemIndex = $direction === 'LEFT'
+                    ? end($itemKeys)
+                    : reset($itemKeys);
+            }
+        } while (!$item->canSelectIndex($selectedItemIndex));
+
+        $item->setSelectedItemIndex($selectedItemIndex);
+    }
+
+    /**
+     * Can the currently selected item actually be selected?
+     *
+     * For example:
+     *  selectable item -> yes
+     *  static item -> no
+     *  split item with only static items -> no
+     *  split item with at least one selectable item -> yes
+     *
+     * @return bool
+     */
+    private function canSelect() : bool
+    {
+        return $this->items[$this->selectedItem]->canSelect();
+    }
+
+    /**
+     * Retrieve the item the user actually selected
+     *
+     */
     public function getSelectedItem() : MenuItemInterface
     {
-        return $this->items[$this->selectedItem];
+        $item = $this->items[$this->selectedItem];
+        return $item instanceof SplitItem
+            ? $item->getSelectedItem()
+            : $item;
     }
 
     /**
@@ -385,6 +441,10 @@ protected function draw() : void
     protected function drawMenuItem(MenuItemInterface $item, bool $selected = false) : array
     {
         $rows = $item->getRows($this->style, $selected);
+
+        if ($item instanceof SplitItem) {
+            $selected = false;
+        }
 
         $invertedColoursSetCode = $selected
             ? $this->style->getInvertedColoursSetCode()