ZFResource^beta

ユーザがコマンドラインで無効な引数を指定すると、 パース関数は Zend_Console_Getopt_Exception をスローします。この例外を、アプリケーションのコードで処理する必要があります。 parse() メソッドを使用して、オブジェクトに引数をパースさせます。 try ブロック内で parse() を実行できるので、便利です。 パースに成功すると、それ以降で再度例外がスローされることはありません。 スローされた例外オブジェクトで、独自のメソッド getUsageMessage() が使用できます。これは、宣言されているすべてのオプションについての 使用法を説明した文字列を返します。

<?php
try {
    $opts = new Zend_Console_Getopt('abp:');
    $opts->parse();
} catch (Zend_Console_Getopt_Exception $e) {
    echo $e->getUsageMessage();
    exit;
}
            

例外が発生するのは、次のような場合です。

getOption() メソッドを使用すると、 オプションの値を問い合わせることができます。 そのオプションがパラメータを持っている場合は、 このメソッドはパラメータの値を返します。 パラメータを持っていないオプションでユーザがパラメータを指定した場合は、 このメソッドは true を返します。 それ以外の場合は、このメソッドは null を返します。

<?php
$opts = new Zend_Console_Getopt('abp:');
$b = $opts->getOption('b');
$p_parameter = $opts->getOption('p');
            

あるいは、マジックメソッド __get() を使用して、 まるでクラスのメンバ変数であるかのようにオプションの値を取得することもできます。 また、マジックメソッド __isset() も実装しています。

<?php
$opts = new Zend_Console_Getopt('abp:');
if (isset($opts->b)) {
    echo "オプション b を取得しました。\n";
}
$p_parameter = $opts->p; // 設定されていない場合は null となります
            

オプションにエイリアスが指定されている場合は、 上の方法でそのエイリアスを使用することもできます。

ユーザがコマンドラインで入力したオプションの全一覧を取得するには、 いくつかの方法があります。

これらのすべての出力メソッドで、フラグ文字列として使用するのは エイリアスリストの先頭にあるものです。たとえば あるオプションのエイリアスが "verbose|v" のように宣言されていたとすると、最初の文字列である "verbose" をオプション名として使用します。 オプションフラグ名には、先頭のダッシュは含みません。

オプション引数およびそのパラメータをコマンドラインからパースした後も、 まだ追加の引数が残っているかも知れません。これらの引数を取得するには getRemainingArgs() メソッドを使用します。このメソッドは、 どのオプションにも属さない文字列の配列を返します。

<?php
$opts = new Zend_Console_Getopt('abp:');
$opts->setArguments(array('-p', 'p_parameter', 'filename'));
$args = $opts->getRemainingArgs(); // array('filename') を返します
            

Zend_Console_Getopt は、GNU の慣習である「ダッシュふたつだけの引数があったら、 オプションはそこで終わりとみなす」をサポートしています。 その後に続く引数は、非オプション引数として扱わなければなりません。 これは、オプションではない引数がダッシュで始まる場合などに有用です。 たとえば "rm -- -filename-with-dash" のような場合です。