PHP CLI Console

Installation

Download a latest package or use Composer:

composer require czproject/phpcli

PhpCli requires PHP 8.0 or later, optionaly Readline extension.

Usage

useCzProject\PhpCli\ConsoleFactory;
require__DIR__ . '/vendor/autoload.php';
$console = ConsoleFactory::createConsole();
// output$console->output('CzProject CLI Simple Console', 'green')
->nl() // new line
->output('Hey!', 'yellow')
->nl()
->output('Fred!', 'blue')
->nl()
->output('Fred is dead!', 'red')
->nl()
->output(['nooooooo...!', '', 'But, no problem!'], 'gray')
->nl()
->output('The end.')
->nl();
// input$username = $console->input('Enter your name');
$console->output('Hello! ', 'blue')
->output($username, 'green')
->output(' [user]', 'yellow')
->nl() // print new line
->output('Bye!', 'blue')
->nl();
// input with default value$username = $console->input('Enter your name', 'John');
// confirm$agree = $console->confirm('Do you want to continue?');
// confirm with default value$canQuit = $console->confirm('Really?', TRUE);
// select$value = $console->select('Select color:', [
'value' => 'label',
'#ff0000' => 'Red',
'#00ff00' => 'Green',
'#0000ff' => 'Blue',
]);
// select with default value$value = $console->select('Select color:', [
'value' => 'label',
'#ff0000' => 'Red',
'#00ff00' => 'Green',
'#0000ff' => 'Blue',
], '#ff0000');

Parameters

Arguments

$name = $console->getArgument(0)->getValue(); // string|NULL$size = $console->getArgument(1, 'int')
->setRequired()
->addRule(function ($value) {
return$value > 0;
})
->getValue();
$price = $console->getArgument(2, 'float') // float
->setDefaultValue(100.0)
->getValue();

Options

$name = $console->getOption('name')->getValue(); // string|NULL$size = $console->getOption('size', 'int')
->setRequired()
->addRule(function ($value) {
return$value > 0;
})
->getValue();
$price = $console->getOption('price', 'float') // float
->setDefaultValue(100.0)
->getValue();
$words = $console->getOption('word')
->setRepeatable()
->getValue();

Supported types

• string
• int and integer
• float
• bool and boolean

---

License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/