2017 © Pedro Peláez
 

library phpcli

Helper class for PHP CLI apps.

image

czproject/phpcli

Helper class for PHP CLI apps.

  • Sunday, June 24, 2018
  • by janpecha
  • Repository
  • 1 Watchers
  • 2 Stars
  • 116 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 2 Open issues
  • 13 Versions
  • 33 % Grown

The README.md

PHP CLI Console

Build Status Downloads this Month Latest Stable Version License, (*1)

Donate, (*2)

Installation

Download a latest package or use Composer:, (*3)

composer require czproject/phpcli

PhpCli requires PHP 8.0 or later, optionaly Readline extension., (*4)

Usage

``` php use CzProject\PhpCli\ConsoleFactory;, (*5)

require DIR . '/vendor/autoload.php';, (*6)

$console = ConsoleFactory::createConsole();, (*7)

// 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();, (*8)

// input $username = $console->input('Enter your name');, (*9)

$console->output('Hello! ', 'blue') ->output($username, 'green') ->output(' [user]', 'yellow') ->nl() // print new line ->output('Bye!', 'blue') ->nl();, (*10)

// input with default value $username = $console->input('Enter your name', 'John');, (*11)

// confirm $agree = $console->confirm('Do you want to continue?');, (*12)

// confirm with default value $canQuit = $console->confirm('Really?', TRUE);, (*13)

// select $value = $console->select('Select color:', [ 'value' => 'label', '#ff0000' => 'Red', '#00ff00' => 'Green', '#0000ff' => 'Blue', ]);, (*14)

// select with default value $value = $console->select('Select color:', [ 'value' => 'label', '#ff0000' => 'Red', '#00ff00' => 'Green', '#0000ff' => 'Blue', ], '#ff0000');, (*15)



## Parameters **Arguments** ```php $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, (*16)

$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, (*17)

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

License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/, (*18)

The Versions

24/06 2018

dev-master

9999999-dev

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

08/06 2018

v3.0.0-beta3

3.0.0.0-beta3

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

24/01 2018

v3.0.0-beta2

3.0.0.0-beta2

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

11/12 2017

v3.0.0-beta

3.0.0.0-beta

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

27/11 2016

v2.0.0

2.0.0.0

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

23/03 2015

dev-version-2

dev-version-2

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

23/03 2015

v2.0.0-beta5

2.0.0.0-beta5

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

20/04 2014

v2.0.0-beta4

2.0.0.0-beta4

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

05/01 2014

v2.0.0-beta3

2.0.0.0-beta3

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

04/12 2013

v2.0.0-beta2

2.0.0.0-beta2

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

01/09 2013

v2.0.0-beta

2.0.0.0-beta

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

The Development Requires

19/04 2013

v1.0.1

1.0.1.0

Helper class for PHP CLI apps.

  Sources   Download

BSD-3-Clause

09/03 2013

v1.0.0

1.0.0.0

Helper class for PHP CLI apps.

  Sources   Download

New BSD License