Console Wars — PHP CLI библиотеки

• Разобрать команду
• Получить параметры и ввод
• Выполнить логику

Разобрать команду

 /** * $argv contains an array of all the arguments passed to the script, * the first argument is always the name of the PHP file. * the Hoa Parser->parse method accept a string in input, so it's necessary to convert the $argv array in a string without the first argument as below. */ unset($argv[0]); $command = implode(' ', $argv); $parser = new Hoa\Console\Parser(); $parser->parse($command); //options definition //['longname', TYPE, 'shortname'] $options = new Hoa\Console\GetOption( [ ['up', Hoa\Console\GetOption::NO_ARGUMENT, 'u'], ['message', Hoa\Console\GetOption::REQUIRED_ARGUMENT, 'm'], ['color', Hoa\Console\GetOption::OPTIONAL_ARGUMENT, 'c'] ], $parser ); с /** * $argv contains an array of all the arguments passed to the script, * the first argument is always the name of the PHP file. * the Hoa Parser->parse method accept a string in input, so it's necessary to convert the $argv array in a string without the first argument as below. */ unset($argv[0]); $command = implode(' ', $argv); $parser = new Hoa\Console\Parser(); $parser->parse($command); //options definition //['longname', TYPE, 'shortname'] $options = new Hoa\Console\GetOption( [ ['up', Hoa\Console\GetOption::NO_ARGUMENT, 'u'], ['message', Hoa\Console\GetOption::REQUIRED_ARGUMENT, 'm'], ['color', Hoa\Console\GetOption::OPTIONAL_ARGUMENT, 'c'] ], $parser ); 

Получить варианты и входные данные

 //definition of default values $uppercase = false; $message = "Hello"; $color = "white"; $names = $parser->getInputs(); //The following while with the switch will assign the values to the variables. while (false !== $shortName = $options->getOption($value)) { switch ($shortName) { case 'u': $uppercase = true; break; case 'm': $message = $value; break; case 'c': $color = $value; break; } } 

Выполнить логику

 $message = new Message($names, $message, $uppercase); $messageString = $message->getMessage(); Hoa\Console\Cursor::colorize('fg('.$color.')'); echo $messageString; Hoa\Console\Cursor::colorize('fg(white)'); //reset the cursor to default white 

Для окрашивания вывода можно изменить цвет Cursor .

Консоль Hoa поддерживает широкий спектр цветов.
Цвет можно установить по имени (черный, красный, зеленый, желтый…), по номеру (от 0 до 256, представляющему цветовую палитру 264) или по шестнадцатеричному коду #rrggbb, пример:
Hoa\Console\Cursor::colorize('fg(yellow) bg(#932e2e) underlined');

Основное использование в этом примере не обеспечивает автоматический вывод вспомогательных данных и не ориентировано строго на ООП, но расширение Hoa\Console\Dispatcher\Kit (требует hoa/dispatcher ) может добавить больше гибкости (больше информации в официальной документации )

Команду можно вызвать с помощью:

 php message.php -u --message=Hello --color=green Nicola Bruno 

Одной из сильных сторон консоли Hoa является то, что она предоставляет дополнительные классы API для управления важными элементами, поддерживая различные профили терминала:

• Cursor (переместить, очистить, показать, раскрасить,…)
• Mouse (слушая действия мыши)
• Window (setSize, прокрутка, сворачивание, …)
• Линия терминала с Readline (история, автозаполнение и т. Д.)

Консоль Webmozart

Рабочий процесс создания команды консоли Webmozart состоит из:

• настройка аргумента и параметров
• писать логику
• создание приложения

Консоль Webmozart следует подходу, аналогичному консоли Symfony, но с четким разделением между конфигурацией и логическим выполнением.

конфигурация

 use Webmozart\Console\Api\Args\Format\Argument; use Webmozart\Console\Api\Args\Format\Option; use Webmozart\Console\Config\DefaultApplicationConfig; /** * Configuration of arguments and options */ class MsgApplicationConfig extends DefaultApplicationConfig { protected function configure() { parent::configure(); $this ->setName('msg') ->setVersion('0.1') ->beginCommand('msg') ->setDescription('Show a nice message') ->setHandler(new MsgCommandHandler()) ->addArgument('names', Argument::MULTI_VALUED | Argument::REQUIRED, 'Who do you want to message?') ->addOption('message', null, Option::OPTIONAL_VALUE, 'Set the message', 'Hello') ->addOption('up', null, Option::NO_VALUE, 'Set the output in uppercase') ->addOption('color', null, Option::REQUIRED_VALUE, 'Which colors do you like?', 'white') ->end() ; } } 

логика

 use Webmozart\Console\Api\Args\Args; use Webmozart\Console\Api\IO\IO; /** * Handling the command logic */ class MsgCommandHandler { public function handle(Args $args, IO $io) { //gets the argument and option $names = $args->getArgument('names'); $message = $args->getOption('message'); $uppercase = $args->getOption('up'); $color = $args->getOption('color'); $message = new Message($names, $message, $uppercase); $messageString = $message->getMessage(); $coloredMsg = '<fg='.$color.'>'.$messageString.'</fg='.$color.'>'; $io->writeLine($coloredMsg); } } 

Сильное разделение конфигурации и логики обеспечивает большую гибкость для простого тестирования и для проекта, который будет расти с дополнительными командами.

Другие преимущества консоли Webmozart:

• поддержка подкоманд:

   php mycommand.php msg send --arg1 --arg2 php mycommand.php msg receive --someoptions=somevalue 

• поддержка документации man-страницы (например, с помощью «git help remote»)

• адаптеры для консоли Symfony (для использования классов Symfony, таких как ProgressBar)

Создание приложения

Файл приложения для запуска команды похож на файл Symfony:

 require 'vendor/autoload.php'; use Webmozart\Console\ConsoleApplication; $cli = new ConsoleApplication(new MsgApplicationConfig()); $cli->run(); 

Консольный звонок:

 php myconsole.php msg --message='Good Morning' Nicola Bruno --color=blue --up 

Последние мысли

Каждая описанная выше консоль предоставляет различные функции для разных типов использования и пользовательских предпочтений.

• Консоль Symfony хорошо протестирована, надежна, имеет хорошую документацию и функции для решения большинства обычных случаев использования.
• Консоль Hoa более ориентирована на отрасль и идеально подходит для манипулирования терминальной средой (мышь, курсор, окно и т. Д.).
• Консоль Webmozart является новой (скоро будет стабильная версия), но она очень полезна для работы с проектами, которые имеют тенденцию расти до больших размеров.

Вы регулярно используете какой-либо из них? Если да, то какой? Почему? Что бы вы сказали за и против каждого? У вас есть другие претенденты, чтобы предложить? Дайте нам знать!