コマンドライン / CLI / コンソール

<?php
// スーパーグローバル変数をコピー
$env    = $context->env->get();
$server = $context->server->get();
$argv   = $context->argv->get();

// これは以下と同様です：
// $value = isset($_ENV['key']) ? $_ENV['key'] : null;
$value = $context->env->get('key');

// これは以下と同様です：
// $value = isset($_ENV['key']) ? $_ENV['key'] : 'other_value';
$value = $context->env->get('key', 'other_value');
?>

<?php
$options = array(
    'a',        // short flag -a です。パラメータの指定を許可しません。
    'b:',       // short flag -b です。パラメータの指定は必須です。
    'c::',      // short flag -c です。パラメータの指定は任意です。
    'foo',      // long option --foo です。 パラメータの指定を許可しません。
    'bar:',     // long option --bar です。 パラメータの指定は必須です。
    'baz::',    // long option --baz パラメータの指定は任意です。
    'g*::',     // short flag -g です。 パラメータの指定は任意で複数指定できます。
);

$getopt = $context->getopt($options);
?>

<?php
$a   = $getopt->get('-a', false); // -a が指定されている場合は true, 指定されていなければfalseです。
$b   = $getopt->get('-b');
$c   = $getopt->get('-c', 'default value');
$foo = $getopt->get('--foo', 0); // --foo が指定されていれば true, 逆の場合 false です。
$bar = $getopt->get('--bar');
$baz = $getopt->get('--baz', 'default value');
$g   = $getopt->get('-g', []);
?>

<?php
// -fは--fooのエイリアスです。
$options = array(
    'foo,f:',  // long option --foo か shot flag -f で指定可能、パラメータは必須です。
);

$getopt = $context->getopt($options);

$foo = $getopt->get('--foo'); // -f も --foo も同じ値です。
$f   = $getopt->get('-f'); // -f も --foo も同じ値です。
?>

<?php
$options = array(
    'f*',
    'foo*:'
);

$getopt = $context->getopt($options);

// もし script が以下の指定とともに実行された場合 :
// php script.php --foo=foo --foo=bar --foo=baz -f -f -f
$foo = $getopt->get('--foo'); // ['foo', 'bar', 'baz']
$f   = $getopt->get('-f'); // [true, true, true]
?>

<?php
$getopt = $context->getopt($options);
if ($getopt->hasErrors()) {
    $errors = $getopt->getErrors();
    foreach ($errors as $error) {
        // Stdioオブジェクトを使った stderr エラーを発行します。
        $stdio->errln($error->getMessage());
    }
};
?>

<?php
$getopt = $context->getopt();

// このスクリプトが以下の指定とともに実行された場合:
// php script.php arg1 arg2 arg3 arg4

$val0 = $getopt->get(0); // script.php
$val1 = $getopt->get(1); // arg1
$val2 = $getopt->get(2); // arg2
$val3 = $getopt->get(3); // arg3
$val4 = $getopt->get(4); // arg4
?>

<?php
$options = array(
    'a',
    'foo:',
);

$getopt = $context->getopt($options);

// このscriptが以下の指定とともに実行された場合:
// php script.php arg1 --foo=bar -a arg2
$arg0 = $getopt->get(0); // script.php
$arg1 = $getopt->get(1); // arg1
$arg2 = $getopt->get(2); // arg2
$foo  = $getopt->get('--foo'); // bar
$a    = $getopt->get('-a'); // 1
?>

<?php
// stdoutに出力します
$stdio->outln('これはノーマルテキストです。');

// stderrに出力します
$stdio->errln('<<red>>これは赤色のエラーです。');
$stdio->errln('フォーマットが再度変更されるまで出力は赤色のままです。<<reset>>');
?>

<?php
use Aura\Cli\CliFactory;
use Aura\Cli\Status;

require '/path/to/Aura.Cli/autoload.php';

// contextとstdioオブジェクトを取得
$cli_factory = new CliFactory;
$context = $cli_factory->newContext($GLOBALS);
$stdio = $cli_factory->newStdio();

// getoptでオプションと名前付き引数を定義
$options = ['verbose,v'];
$getopt = $context->getopt($options);

// 誰にhelloと出力するか？
$name = $getopt->get(0);
if (! $name) {
    // エラー出力
    $stdio->errln("Please give a name to say hello to.");
    exit(Status::USAGE);
}

// say hello
if ($getopt->get('--verbose')) {
    // 詳細エラー
    $stdio->outln("Hello {$name}, it's nice to see you!");
} else {
    // エラー
    $stdio->outln("Hello {$name}!");
}

// done!
exit(Status::SUCCESS);
?>

<?php
use Aura\Cli\Help;

class MyCommandHelp extends Help
{
    protected function init()
    {
        $this->setSummary('A single-line summary.');
        $this->setUsage('<arg1> <arg2>');
        $this->setOptions(array(
            'f,foo' => "The -f/--foo option description",
            'bar::' => "The --bar option description",
        ));
        $this->setDescr("A multi-line description of the command.");
    }
}
?>

<?php
use Aura\Cli\CliFactory;
use Aura\Cli\Context\OptionFactory;

$cli_factory = new CliFactory;
$stdio = $cli_factory->newStdio();

$help = new MyCommandHelp(new OptionFactory);
$stdio->outln($help->getHelp('my-command'));
?>

SUMMARY
    my-command -- A single-line summary.

USAGE
    my-command <arg1> <arg2>

DESCRIPTION
    A multi-line description of the command.

OPTIONS
    -f
    --foo
        The -f/--foo option description.

    --bar[=<value>]
        The --bar option description.

<?php
namespace Aura\Famework_Project\_Config;

use Aura\Di\Config;
use Aura\Di\Container;

class Common extends Config
{
    // ...

    public function modifyCliDispatcher(Container $di)
    {
        $context = $di->get('aura/cli-kernel:context');
        $stdio = $di->get('aura/cli-kernel:stdio');
        $dispatcher = $di->get('aura/cli-kernel:dispatcher');
        $dispatcher->setObject(
            'foo',
            function ($id = null) use ($context, $stdio) {
                if (! $id) {
                    $stdio->errln("Please pass an ID.");
                    return \Aura\Cli\Status::USAGE;
                }

                $id = (int) $id;
                $stdio->outln("You passed " . $id . " as the ID.");
            }
        );
    }
?>

<?php
/**
 * {$PROJECT_PATH}/src/App/Command/FooCommand.php
 */
namespace App\Command;

use Aura\Cli\Stdio;
use Aura\Cli\Context;
use Aura\Cli\Status;

class FooCommand
{
    public function __construct(Context $context, Stdio $stdio)
    {
        $this->context = $context;
        $this->stdio = $stdio;
    }

    public function __invoke($id = null)
    {
        if (! $id) {
            $this->stdio->errln("Please pass an ID.");
            return Status::USAGE;
        }

        $id = (int) $id;
        $this->stdio->outln("You passed " . $id . " as the ID.");
    }
}
?>

<?php
namespace Aura\Famework_Project\_Config;

use Aura\Di\Config;
use Aura\Di\Container;

class Common extends Config
{
    public function define(Container $di)
    {
        $di->set('aura/project-kernel:logger', $di->newInstance('Monolog\Logger'));

        $di->params['App\Command\FooCommand'] = array(
            'context' => $di->lazyGet('aura/cli-kernel:context'),
            'stdio' => $di->lazyGet('aura/cli-kernel:stdio'),
        );
    }

    // ...

    public function modifyCliDispatcher(Container $di)
    {
        $dispatcher = $di->get('aura/cli-kernel:dispatcher');

        $dispatcher->setObject(
            'foo',
            $di->lazyNew('App\Command\FooCommand')
        );
    }
?>