Allow registering custom item styles

Author: AydinHassan

examples/basic.php

@@ -1,20 +1,50 @@
 <?php
 
+use PhpSchool\CliMenu\Builder\SplitItemBuilder;
 use PhpSchool\CliMenu\CliMenu;
 use PhpSchool\CliMenu\Builder\CliMenuBuilder;
+use PhpSchool\CliMenu\MenuItem\SelectableItem;
+use PhpSchool\CliMenu\Style\SelectableStyle;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
 $itemCallable = function (CliMenu $menu) {
     echo $menu->getSelectedItem()->getText();
 };
 
+class MyItem extends SelectableItem {
+
+};
+
+class MySelectableStyle extends SelectableStyle {
+
+}
+
+$myItem = new MyItem('YO', $itemCallable);
+$myItem2 = new MyItem('YO2', $itemCallable);
+
 $menu = (new CliMenuBuilder)
+    ->registerItemStyle(MyItem::class, new MySelectableStyle())
+//    ->modifyStyle(MySelectableStyle::class, function (MySelectableStyle $style) {
+//        $style->setUnselectedMarker('[#]');
+//    })
     ->setTitle('Basic CLI Menu')
     ->addItem('First Item', $itemCallable)
     ->addItem('Second Item', $itemCallable)
     ->addItem('Third Item', $itemCallable)
     ->addLineBreak('-')
+    ->addMenuItem($myItem)
+    ->addMenuItem($myItem2)
+    ->addSubMenu('OPT', function (CliMenuBuilder $b) use ($myItem) {
+        $b->addMenuItem($myItem);
+    })
+    ->addSplitItem(function (SplitItemBuilder $b) use ($itemCallable, $myItem) {
+        $b->addItem('FIRST SPLIT', $itemCallable);
+        $b->addSubMenu('SUB', function (CliMenuBuilder $b) use ($myItem) {
+            $b->addMenuItem($myItem);
+        });
+        $b->addMenuItem($myItem);
+    })
     ->build();
 
 $menu->open();

src/Builder/CliMenuBuilder.php

@@ -18,10 +18,12 @@
 use PhpSchool\CliMenu\MenuStyle;
 use PhpSchool\CliMenu\Style\CheckboxStyle;
 use PhpSchool\CliMenu\Style\DefaultStyle;
+use PhpSchool\CliMenu\Style\ItemStyle;
 use PhpSchool\CliMenu\Style\RadioStyle;
 use PhpSchool\CliMenu\Style\SelectableStyle;
 use PhpSchool\CliMenu\Terminal\TerminalFactory;
 use PhpSchool\Terminal\Terminal;
+use function PhpSchool\CliMenu\Util\each;
 
 /**
  * @author Michael Woodward <[email protected]>
@@ -80,6 +82,11 @@ class CliMenuBuilder
      */
     private $autoShortcutsRegex = '/\[(.)\]/';
 
+    /**
+     * @var array
+     */
+    private $extraItemStyles = [];
+
     /**
      * @var bool
      */
@@ -187,6 +194,10 @@ public function addSubMenu(string $text, \Closure $callback) : self
             $builder->enableAutoShortcuts($this->autoShortcutsRegex);
         }
 
+        each($this->extraItemStyles, function (int $i, array $extraItemStyle) use ($builder) {
+            $builder->registerItemStyle($extraItemStyle['class'], $extraItemStyle['style']);
+        });
+
         $callback($builder);
 
         $menu = $builder->build();
@@ -293,6 +304,10 @@ public function addSplitItem(\Closure $callback) : self
             $builder->enableAutoShortcuts($this->autoShortcutsRegex);
         }
 
+        foreach ($this->extraItemStyles as $extraItemStyle) {
+            $builder->registerItemStyle($extraItemStyle['class'], $extraItemStyle['style']);
+        }
+
         $callback($builder);
 
         $this->menu->addItem($splitItem = $builder->build());
@@ -603,4 +618,21 @@ public function modifyRadioStyle(callable $itemCallable) : self
 
         return $this;
     }
+
+    public function modifyStyle(string $styleClass, callable $itemCallable) : self
+    {
+        $itemCallable($this->menu->getItemStyle($styleClass));
+
+        return $this;
+    }
+
+    public function registerItemStyle(string $itemClass, ItemStyle $itemStyle) : self
+    {
+        $this->menu->getStyleLocator()
+            ->registerItemStyle($itemClass, $itemStyle);
+
+        $this->extraItemStyles[] = ['class' => $itemClass, 'style' => $itemStyle];
+
+        return $this;
+    }
 }

src/Builder/SplitItemBuilder.php

@@ -5,11 +5,14 @@
 use PhpSchool\CliMenu\CliMenu;
 use PhpSchool\CliMenu\MenuItem\CheckboxItem;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
+use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
 use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
 use PhpSchool\CliMenu\MenuItem\RadioItem;
 use PhpSchool\CliMenu\MenuItem\SelectableItem;
 use PhpSchool\CliMenu\MenuItem\SplitItem;
 use PhpSchool\CliMenu\MenuItem\StaticItem;
+use PhpSchool\CliMenu\Style\ItemStyle;
+use function \PhpSchool\CliMenu\Util\each;
 
 /**
  * @author Aydin Hassan <[email protected]>
@@ -42,6 +45,11 @@ class SplitItemBuilder
      */
     private $autoShortcutsRegex = '/\[(.)\]/';
 
+    /**
+     * @var array
+     */
+    private $extraItemStyles = [];
+
     public function __construct(CliMenu $menu)
     {
         $this->menu = $menu;
@@ -103,6 +111,10 @@ public function addSubMenu(string $text, \Closure $callback) : self
             $builder->enableAutoShortcuts($this->autoShortcutsRegex);
         }
 
+        each($this->extraItemStyles, function (int $i, array $extraItemStyle) use ($builder) {
+            $builder->registerItemStyle($extraItemStyle['class'], $extraItemStyle['style']);
+        });
+
         $callback($builder);
 
         $menu = $builder->build();
@@ -117,6 +129,13 @@ public function addSubMenu(string $text, \Closure $callback) : self
         return $this;
     }
 
+    public function addMenuItem(MenuItemInterface $item) : self
+    {
+        $this->splitItem->addItem($item);
+
+        return $this;
+    }
+
     public function setGutter(int $gutter) : self
     {
         $this->splitItem->setGutter($gutter);
@@ -135,6 +154,13 @@ public function enableAutoShortcuts(string $regex = null) : self
         return $this;
     }
 
+    public function registerItemStyle(string $itemClass, ItemStyle $itemStyle) : self
+    {
+        $this->extraItemStyles[] = ['class' => $itemClass, 'style' => $itemStyle];
+
+        return $this;
+    }
+
     public function build() : SplitItem
     {
         return $this->splitItem;

src/CliMenu.php

@@ -666,6 +666,11 @@ public function getItemStyleForItem(MenuItemInterface $item) : ItemStyle
         return $this->itemStyleLocator->getStyleForMenuItem($item);
     }
 
+    public function getStyleLocator() : Locator
+    {
+        return $this->itemStyleLocator;
+    }
+
     public function importStyles(CliMenu $menu) : void
     {
         if (!$this->style->hasChangedFromDefaults()) {

src/Style/Exception/InvalidStyle.php

@@ -22,4 +22,9 @@ public static function unregisteredItem(string $itemClass) : self
     {
         return new self("Menu item: '$itemClass' does not have a registered style class");
     }
+
+    public static function itemAlreadyRegistered(string $itemClass) : self
+    {
+        return new self("Menu item: '$itemClass' already has a registered style class");
+    }
 }

src/Style/Locator.php

@@ -97,4 +97,14 @@ public function getStyleForMenuItem(MenuItemInterface $item) : ItemStyle
 
         return $this->getStyle($styleClass);
     }
+
+    public function registerItemStyle(string $itemClass, ItemStyle $itemStyle) : void
+    {
+        if (isset($this->itemStyleMap[$itemClass])) {
+            throw InvalidStyle::itemAlreadyRegistered($itemClass);
+        }
+
+        $this->itemStyleMap[$itemClass] = get_class($itemStyle);
+        $this->styles[get_class($itemStyle)] = $itemStyle;
+    }
 }