Console_Getopt::getopt
Console_Getopt::getopt – コマンドラインオプションを取得する
Synopsis
require_once 'Console/Getopt.php';
array getopt (
array $args
, string $shortoptions
, array
$longoptions
= = null
)
Description
コマンドラインオプションをパースし、結果を返します。
Parameter
-
array $args
- コマンドライン引数の配列。
-
string $shortoptions
-
使用できる短いオプション目録を指定します。
詳細については、
オプションについてのセクション
を参照してください。
-
array $longoptions
-
使用できる長いオプション目録を指定します。
詳細については、
オプションについてのセクション
を参照してください。
Return value
array
-
パースされたオプションと非オプションのコマンドライン引数の
2つの要素からなる配列、もしくは PEAR_Error 。
Throws
Possible PEAR_Error values
エラーコード |
エラーメッセージ |
理由 |
対処法 |
NULL |
"Console_Getopt: option --$opt
is ambiguous"
|
同じ文字から始まるオプションが複数あります。
|
オプションの名称を変えます。タイプミスによって、このエラーが
起こることもあります。
|
NULL |
"Console_Getopt: option --$opt
requires an argument"
|
オプションにパラメータが付加されていません。
|
ふつうは、ユーザのミスです。
もしパラメータの付加が任意であるならば、オプション定義に、
任意と記述します。
|
NULL |
"Console_Getopt: option --$opt
doesn't allow an argument"
|
オプションにパラメータが付加されています。
|
ふつうは、ユーザのミスです。
もしパラメータの付加が必要であるならば、オプション定義に
そのように記述します。
|
NULL |
"Console_Getopt: unrecognized option
--$opt
"
|
不明なオプションです。
|
ふつうは、ユーザのミスです。
もしそのパラメータが存在するはずならば、オプション定義にて
定義します。
|
Note
This function can not be called
statically.