proc_open
コマンドを実行し、入出力用にファイルポインタを開く
&reftitle.description;
resourceproc_open
stringcmd
arraydescriptorspec
arraypipes
stringcwd
arrayenv
arrayother_options
proc_open は popen と
よく似ていますが、プログラムの実行をさらに細かく制御できる点で違います。
&reftitle.parameters;
cmd
実行されるコマンド。
descriptorspec
数値添字の配列で、ディスクリプタ番号をキーとし、PHP がその
ディスクリプタをどのように子プロセスに渡すかを表すのが
対応する値となります。
0 が標準入力 (stdin)、1 が標準出力 (stdout) で、
2 が標準エラー出力 (stderr) となります。
各要素は、次のようになります。
プロセスに渡すパイプをあらわす配列。
最初の要素はディスクリプタの型で、2 番目の要素がその型に対応するオプションとなります。
使用できる型は pipe (2 番目の要素は、
プロセスにパイプの読み込み側を渡すのなら r、
書き込み側を渡すのなら w)
および file (2 番目の要素はファイル名)
です。
実際のファイルディスクリプタ (オープンしたファイルやソケット、
STDIN など) をあらわすストリームリソース。
ファイルディスクリプタの番号は、特に 0, 1, 2 に限られているわけでは
ありません。有効であるどのようなファイルディスクリプタの番号も指定でき、
それは子プロセスに渡されます。これにより、あるスクリプトと、
子プロセスとして起動している別のスクリプトとの間で通信ができます。
特に、これは PGP や GPG、openssl といったプログラムにパスフレーズを
より安全な方法で渡したいとき威力を発揮します。
補助的なファイルディスクリプタを介して、そのようなプログラムの
状態を取得するのにも便利です。
pipes
PHP 側で生成されたパイプの終端にあたる
ファイルポインタの配列。
cwd
コマンドの初期作業ディレクトリ。
完全パスである必要があります。
デフォルト値 (現在の PHP プロセスの作業ディレクトリ) を使用したい場合は
&null; を指定します。
env
実行するコマンドのための環境変数の配列。
現在の PHP プロセスと同じ環境変数を使用する場合は
&null; を指定します。
other_options
その他の追加オプションを指定することが可能です。
現在サポートされているオプションは次の通りです。
suppress_errors (windows のみ):
&true; にすると、この関数が出力するエラーを抑制します。
bypass_shell (windows のみ):
&true; にすると、cmd.exe シェルをバイパスします。
&reftitle.returnvalues;
プロセスを表すリソースを返します。このリソースは、使用し終えた際に
proc_close を使用して開放する必要があります。
失敗した場合は &false; を返します。
&reftitle.changelog;
&Version;
&Description;
5.2.1
other_options パラメータに
オプション bypass_shell が追加されました。
5.0.0
パラメータ cwd、env
および other_options が追加されました。
&reftitle.examples;
A proc_open の例
array("pipe", "r"), // stdin は、子プロセスが読み込むパイプです。
1 => array("pipe", "w"), // stdout は、子プロセスが書き込むパイプです。
2 => array("file", "/tmp/error-output.txt", "a") // はファイルで、そこに書き込みます。
);
$cwd = '/tmp';
$env = array('some_option' => 'aeiou');
$process = proc_open('php', $descriptorspec, $pipes, $cwd, $env);
if (is_resource($process)) {
// $pipes はこの時点で次のような形を取っています。
// 0 => 子プロセスの stdin に繋がれた書き込み可能なハンドル
// 1 => 子プロセスの stdout に繋がれた読み込み可能なハンドル
// すべてのエラー出力は /tmp/error-output.txt に書き込みされます。
fwrite($pipes[0], '');
fclose($pipes[0]);
echo stream_get_contents($pipes[1]);
fclose($pipes[1]);
// デッドロックを避けるため、proc_close を呼ぶ前に
// すべてのパイプを閉じることが重要です。
$return_value = proc_close($process);
echo "command returned $return_value\n";
}
?>
]]>
&example.outputs.similar;
aeiou
[PWD] => /tmp
[SHLVL] => 1
[_] => /usr/local/bin/php
)
command returned 0
]]>
&reftitle.notes;
Windows における互換性: 2 (stderr) よりも大きな番号のディスクリプタは
子プロセスに継承可能なハンドルとして渡されますが、
Windows のアーキテクチャは、ファイルディスクリプタの番号と
より低レベルなハンドルを関連付けないので、子プロセスは、
それらのハンドルにアクセスする術を持ちません。stdin, stdout, stderr
は期待通り動きます。
もし単方向(一方向)のパイプを利用したいだけでしたら、
popen を使うほうがより簡単です。
&reftitle.seealso;
popen
exec
system
passthru
stream_select
バックティック演算子