3 Commits

2 changed files with 85 additions and 9 deletions

31
examples/input.php Normal file
View File

@ -0,0 +1,31 @@
<?php
/*
* This example demonstrates how to use events to catch commands that
* have not been handled by any context or builtin.
*
*/
require_once __DIR__."/../vendor/autoload.php";
use NoccyLabs\Shell\Shell;
use NoccyLabs\Shell\Style;
use NoccyLabs\Shell\Context;
$myShell = new Shell();
// Set the initial prompt, not really needed.
$myShell->setPrompt("test>");
// Create an anonymous context and add a command
$ctx = $myShell->createContext("root");
$ctx->addCommand("hello", function () use ($myShell) {
$myShell->getInput("What is your name?", function ($name) use ($myShell) {
echo "Hello, {$name}\n";
$myShell->getInput("Who is your daddy and what does he do?", function ($daddy) {
echo "{$daddy}? Oookay...\n";
});
});
});
// Run the shell
$myShell->run();

View File

@ -54,6 +54,18 @@ class Shell
* @var Style The style applied to the input text * @var Style The style applied to the input text
*/ */
protected $input_style = null; protected $input_style = null;
/**
* @var callable The callback to pass the input on to
*/
protected $input_callback = null;
/**
* @var string Question prompt for getInput()
*/
protected $input_prompt = null;
/**
* @var string The prompt before changing to $input_prompt
*/
protected $input_last_prompt = null;
/** /**
* Constructor * Constructor
@ -227,7 +239,7 @@ class Shell
public function setPrompt($text) public function setPrompt($text)
{ {
$this->prompt = $text; $this->prompt = $text;
if ($this->lineReader) { if ($this->lineReader) {
$this->lineReader->setPromptText($text); $this->lineReader->setPromptText($text);
} }
@ -395,19 +407,27 @@ class Shell
} }
} }
ksort($ghelp); ksort($ghelp);
printf("Commands in current context:\n"); $_ = function($command,$args,$info) {
printf(" \e[97m%s\e[0m \e[90;3m%s\e[0m - \e[36m%s\e[0m\n", $command, $args, $info);
};
printf("\e[1mCommands:\e[0m\n");
foreach ($help as $command=>$info) { foreach ($help as $command=>$info) {
printf(" %-20s %s\n", $command, $info); if (strpos($command," ")!==false) {
list($command,$args) = explode(" ",$command,2);
} else $args=null;
$_($command, $args,$info);
} }
if (count($ghelp)) { if (count($ghelp)) {
printf("\nImported from parent contexts:\n"); printf("\n\e[0mCommands from parent contexts:\e[0m\n");
foreach ($ghelp as $command=>$info) { if (strpos($command," ")!==false) {
printf(" %-20s %s\n", $command, $info); list($command,$args) = explode(" ",$command,2);
} } else $args=null;
$_($command, $args,$info);
} }
printf("\nGlobal commands:\n"); printf("\nGlobal commands:\n");
printf(" %-20s %s\n", "exit", "Leave the shell"); $_("exit", null, "Leave the shell");
printf(" %-20s %s\n", "..", "Discard the current context and go to parent"); $_(".", null, "Show the context tree");
$_("..", null, "Discard the current context and go to parent");
break; break;
case 'exit': case 'exit':
$this->stop(); $this->stop();
@ -532,6 +552,31 @@ class Shell
return $event; return $event;
} }
public function getInput($prompt, callable $callback)
{
$this->addListener(Shell::EVT_UPDATE_PROMPT, [ $this, "onInputPrompt" ], $prompt);
$this->addListener(Shell::EVT_BEFORE_COMMAND, [ $this, "onInputHandler" ], $this->prompt, $callback);
}
public function onInputPrompt(Event $e, $prompt)
{
$this->setPrompt($prompt);
$e->stopPropagation();
$this->removeListener(Shell::EVT_UPDATE_PROMPT, [ $this, "onInputPrompt" ], $prompt);
}
public function onInputHandler(Event $e, $last_prompt, $callback)
{
// Restore the prompt
$this->setPrompt($last_prompt);
// Remove the listeners and compose the result string
$this->removeListener(Shell::EVT_BEFORE_COMMAND, [ $this, "onInputHandler" ], $last_prompt, $callback);
$input = trim($e->command." ".join(" ",$e->args));
$e->stopPropagation();
// Call the callback
call_user_func($callback, $input);
}
/** /**
* Stop the shell; calling this method will cause the main run() to return. * Stop the shell; calling this method will cause the main run() to return.
* *