Download the PHP package jjulien/php-cli-helper without Composer
On this page you can find all versions of the php package jjulien/php-cli-helper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jjulien/php-cli-helper
More information about jjulien/php-cli-helper
Files in jjulien/php-cli-helper
Package php-cli-helper
Short Description Helper for creating CLI based PHP programs
License Apache-2.0
Informations about the package php-cli-helper
PHP CLI Helper
PHP CLI Helper was created to make developing PHP command line tools easy. It currently supports command line option parsing and validation.
Usage Summary
The main class is the CLIHelper\Helper
. You will tell this class all of the options you want to support and how you want that option to behave. After you tell the helper to parse the options, it will validate that the user has not violated any of the rules you defined for how your options should behave. If violations are found, the user receives a help message showing them how the option are suppose to work and which option rule they violated. If no violations are found, you then user the helper object to retrieve values for options and determine which options the user specified.
Usage Example
Code
Invocation
Adding Options
There are two ways to add options. You can use the CLIHelper\OptionBuilder
class, which can get using the convenience method ->newOption()
on CLIHelper\Helper. You can also create your own
CLIHelper\Optionobject and call
->addOption($option)on
CLIHelper\Helper`.
Options can either by of type Option::TYPE_BOOLEAN
or Option::TYPE_VALUE
, the default is Option::TYPE_VALUE
. Option::TYPE_BOOLEAN
options are options that are either on or off, such as the common "verbose" option. It takes no value, it's either provided on the command line or it is not. Option::TYPE_VALUE
options read a value in that comes on the comman line right after the option. An example would be --file-in filename
where --file-in
must have a value provided along with it.
Example using ->addOption($option)
Example using ->newOption()