enygma/cmd

A simple command line option parser

0.4 2016-06-09 13:18 UTC

This package is auto-updated.

Last update: 2022-09-15 06:09:18 UTC


README

Travis-CI Build Status

This library provides some handy utilities for working on the command line:

  • a simple interface for parsing the $_SERVER['argv'] input values out into key/value pairs (Command)
  • an output handling library making formatted output easy (Output)

Installation

Using Composer:

composer require enygma/cmd

Example Usage:

<?php

require_once 'vendor/autoload.php';
use Cmd\Command;

$cmd = new Command();
$args = $cmd->execute($_SERVER['argv']);

echo 'RESULT: '.var_export($args, true)."\n";
?>

Command: Example

For the command line call of:

php test.php plain-arg --foo --bar=baz --funny="spam=eggs" --also-funny=spam=eggs 'plain arg 2' -abc -k=value "plain arg 3" --s="original" --s='overwrite' --s

The result would be:

Array
(
    [0] => plain-arg
    [foo] => 1
    [bar] => baz
    [funny] => spam=eggs
    [also-funny] => spam=eggs
    [1] => plain arg 2
    [abc] => 1
    [k] => value
    [2] => plain arg 3
    [s] => 1
)

Options that are either plain arguments (like plain-arg or plain arg 3) will just be added to the results with numeric indexes. The other options will be assiged as key/value pairs in the resulting array. For values that are set (like -abc or --foo) but don't have a value, the value will be set to the boolean true.

Command: Required and default

You can also set up default values and required parameters for your command line options. Use the optional second paramster on the execute method call to define these:

<?php

require_once 'vendor/autoload.php';
use Cmd\Command;

$cmd = new Command();
$config = [
  'default' => ['foo' => true],
  'required' => ['bar']
];

$args = $cmd->execute($_SERVER['argv'], $config);

echo 'RESULT: '.var_export($args, true)."\n";

?>

The default values are defined as an array of parameter name => default value. The required settings are just presented as an array of option names.

Output: Example

<?php

require_once 'vendor/autoload.php';
use Cmd\Output;

$out = new Output();
$out->success('Success message goes here!');
?>

Default methods:

  • success
  • warning
  • info
  • error

You can also define a custom type if you want a reusable format:

<?php
require_once 'vendor/autoload.php';
use Cmd\Output;

$out = new Output();
$out->addType('custom1', 'white', 'blue');

$out->custom1('A custom message');
?>

The first parameter is the name of the custom format. The second and third are the foreground and background colors.