addCustomControlMapping for opening subMenu ?

[vesper8]

I can set keyboard mapping for regular callables but I would like to use it to open a submenu.. any way to achieve that?

        $subMenu = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $exit = function (CliMenu $menu) {
            $menu->close();
        };

        $menu = (new CliMenuBuilder)
        ->addSubMenu('[S]uper Sub Menu', $subMenu)
        ->build();

        $menu->addCustomControlMapping('x', $exit);
        $menu->addCustomControlMapping('s', $subMenu);

        $menu->open();

[AydinHassan]

Unfortunately I don't think there is a way to do this. I think you could maybe hack it in somehow like this:

$menu->addCustomControlMapping('s', function (CliMenu $menu) {
    foreach ($menu->getItems() as $item) {
        if ($item instanceof MenuMenuItem && $item-> getSubMenu()->getTitle() === 'Behold the awesomeness') {
            $item->showSubMenu($menu);
        }
    }
});

Not tested though!

[AydinHassan]

I'd be open to a better way of doing this if you can think of one.

[AydinHassan]

Actually that doesn't work, but this does:

<?php

use PhpSchool\CliMenu\CliMenu;
use PhpSchool\CliMenu\Builder\CliMenuBuilder;
use PhpSchool\CliMenu\MenuItem\MenuMenuItem;

require_once(__DIR__ . '/../vendor/autoload.php');

$subMenu = function (CliMenuBuilder $b) {
    $b->setTitle('Behold the awesomeness')
        ->addItem('Print Hello', function () { echo 'Hello!'; });
};

$exit = function (CliMenu $menu) {
    $menu->close();
};

$menu = (new CliMenuBuilder)
    ->addSubMenu('[S]uper Sub Menu', $subMenu)
    ->build();

$menu->addCustomControlMapping('x', $exit);
$menu->addCustomControlMapping('s', function (CliMenu $menu) {
    foreach ($menu->getItems() as $item) {
        if ($item instanceof MenuMenuItem && $item->getText() === '[S]uper Sub Menu') {
            $item->showSubMenu($menu);
        }
    }
});

$menu->open();

[vesper8]

thanks a lot for finding a workaround! it's a bit wordy though.. guess I can wrap it in a method since I have many sub-menus I want to do this for. Maybe in a future version it could be built-in. If the 2nd argument passed to addCustomControlMapping is an instance of CliMenuBuilder then iterate through the menu's items and find the one with the matching title?

Another thing I wanted to ask about.. maybe I should create another issue for it.. is if we can have the ability to map keyboard shorcuts based on the current visible menu

Since I have a lot of sub-menus, I might want to re-use keyboard letters based on the menu that is currently shown to the user. I have to admit I haven't tried this yet so maybe it already works by default.

[AydinHassan]

Hey yeah I'd be happy to accept a PR to make that easier. Unfortunately It's not something I will be doing myself. Another option would be to just accept the shortcut key as a third parameter to addSubMenu.

Regarding the second thing, I'm unsure, try it :)

[vesper8]

I might submit a PR later for the other things, for now I've hacked up this quick method that scans all menu items for letters in between square brackets and automatically assigns keyboard shortcuts to those it finds. I did very little testing but this demo works

        $subMenu1 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #1')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $subMenu2 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #2')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $menu = (new CliMenuBuilder)
        ->addSubMenu('[S]uper Sub Menu #1', $subMenu1)
        ->addSubMenu('S[u]per Sub Menu #2', $subMenu2)
        ->build();

        $this->autoMapKeyboardShortcuts($menu);

    public function autoMapKeyboardShortcuts($menu)
    {
        foreach ($menu->getItems() as $item) {
            if ($item instanceof \PhpSchool\CliMenu\MenuItem\MenuMenuItem && preg_match('/\[(.*?)\]/i', $item->getText(), $match)) {
                $menuItemText = $item->getText();
                $shortcutKey = strtolower($match[1]);

                $menu->addCustomControlMapping($shortcutKey, function (\PhpSchool\CliMenu\CliMenu $menu) use ($menuItemText) {
                    foreach ($menu->getItems() as $item) {
                        if ($item instanceof \PhpSchool\CliMenu\MenuItem\MenuMenuItem && $item->getText() === $menuItemText) {
                            $item->showSubMenu($menu);
                        }
                    }
                });
            }
        }
    }

Not the prettiest but useful.. let me know if you want a PR for that

[AydinHassan]

I like the idea! @Lynesth @mikeymike what do you think? I think some people might think it's a bit magic, but I dig it, so just checking with others.

[vesper8]

I started using it and noticed that I can't bind the letter 'm' ? it's somehow.. reserved?

        $subMenu1 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #1')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $subMenu2 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #2')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $menu = (new CliMenuBuilder)
        ->addSubMenu('[S]uper Sub Menu #1', $subMenu1)
        ->addSubMenu('Super Sub [M]enu #2', $subMenu2)
        ->build();

        $this->autoMapKeyboardShortcuts($menu);

        $menu->open();

InvalidArgumentException  : Cannot rebind this input

I can't find anywhere in your source where the letter 'm' is bound and pressing it does nothing.. so I'm confused.. works with other letters.. though I haven't tried the whole alphabet

[mikeymike]

definitely something of value imo, would need a little documentation to go with as I can imagine there's a few caveats with nested menus.

[mikeymike]

@vesper8 https://github.com/php-school/cli-menu/blob/master/src/CliMenu.php#L74

[vesper8]

ahh.. I see.. are those like.. VIM mappings? seems weird.. I would like to be able to disable that or override them

I also just improved my magic method to work with selectable items as well as menu items

        $subMenu1 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #1')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $subMenu2 = function (CliMenuBuilder $b) {
            $b->setTitle('Behold the awesomeness #2')
                ->addItem('Print Hello', function () { echo 'Hello!'; });
        };

        $menu = (new CliMenuBuilder)
        ->addSubMenu('[S]uper Sub Menu #1', $subMenu1)
        ->addSubMenu('S[u]per Sub Menu #2', $subMenu2)
        ->addItem('[A]', function () { echo 'A'; })
        ->build();

        $this->autoMapKeyboardShortcuts($menu);

        $menu->open();

    public function autoMapKeyboardShortcuts($menu)
    {
        foreach ($menu->getItems() as $item) {
            if (preg_match('/\[(.*?)\]/i', $item->getText(), $match)) {
                $menuItemText = $item->getText();
                $shortcutKey = strtolower($match[1]);

                $menu->addCustomControlMapping($shortcutKey, function (\PhpSchool\CliMenu\CliMenu $menu) use ($menuItemText) {
                    foreach ($menu->getItems() as $item) {
                        if ($item->getText() === $menuItemText) {
                            switch (true) {
                                case $item instanceof \PhpSchool\CliMenu\MenuItem\MenuMenuItem:
                                    $item->showSubMenu($menu);
                                break;

                                case $item instanceof \PhpSchool\CliMenu\MenuItem\SelectableItem:
                                    $callable = $item->getSelectAction();
                                    $callable($menu);
                                break;
                            }
                        }
                    }
                });
            }
        }
    }

[Lynesth]

@vesper8
That's very unfortunate as I cannot find the code I wrote a while ago for a client using CliMenu since it was pretty much doing that.

Anyway, here is another way of doing it, defining each menu separatly from children to parents

use PhpSchool\CliMenu\CliMenu;
use PhpSchool\CliMenu\Action\GoBackAction;
use PhpSchool\CliMenu\Builder\CliMenuBuilder;

require_once 'vendor/autoload.php';

$subMenuBuilder1 = (new CliMenuBuilder)
        ->disableDefaultItems();
        ->setTitle('CLI Menu > Options')
        ->addItem('First option', function () { echo ("I am an option"); })
        ->addLineBreak('-')
        ->addItem('Go Back', new GoBackAction); // Adding the "Go Back" manually, you can also add the "Exit" if wanted.
$subMenu1 = $subMenuBuilder1->build();

$mainMenuBuilder = (new CliMenuBuilder)
        ->setTitle('CLI Menu')
        ->addItem('First Item', function() { echo "Hello"; })
        ->addStaticItem('Second Item')
        ->addLineBreak('-')
        ->addSubMenuFromBuilder('Options', $subMenuBuilder1)
        ->setWidth(70);
$mainMenu = $mainMenuBuilder->build();

$mainMenu->addCustomControlMapping('o', function(CliMenu $menu) use ($subMenu1) {
        // Closing parent and opening sub
        $menu->closeThis();
        $subMenu1->open();
});

$mainMenu->open();

We could improve the whole thing I agree...

[AydinHassan]

Yeah I think a method to disable vim mappings should be fine. I would like to see the method autoMapKeyboardShortcuts on the CliMenuBuilder though if at all possible, and it would be nice to set it once on the parent builder and not have to set it again on each child builder.