PHPコマンドラインモード

バージョン 4.3.0 以降、PHP は、コマンド ライン インターフェイス、つまりコマンド ライン インターフェイスを意味する CLI と呼ばれる、新しいタイプの CLI SAPI (サーバー アプリケーション プログラミング インターフェイス、サーバー アプリケーション プログラミング ポート) サポートを提供します。名前が示すように、CLI SAPI モジュールは主に PHP の開発シェル アプリケーションとして使用されます。 CLI SAPI と他の CLI SAPI モジュールの間には多くの違いがありますが、それについてはこの章で詳しく説明します。 CLI と CGI は多くの共通の動作を共有しますが、異なる SAPI であることに言及する価値があります。

CLI SAPI は PHP 4.2.0 で最初にリリースされましたが、まだ実験版にすぎず、./configure の実行時に --enable-cli パラメーターを追加する必要があります。 PHP バージョン 4.3.0 以降、CLI SAPI は正式なモジュールになりました。 --enable-cli パラメータはデフォルトで on に設定され、パラメータ --disable-cli でブロックすることもできます。

PHP 4.3.0 以降、CLI/CGI バイナリ実行可能ファイルのファイル名、場所、存在は、PHP がシステムにどのようにインストールされているかによって異なります。デフォルトでは、make を実行すると、CGI と CLI がコンパイルされ、PHP ソース ファイル ディレクトリのそれぞれ sapi/cgi/php と sapi/cli/php の下に配置されます。両方のファイルの名前が php であることに注意してください。 make install 中に何が起こるかは、設定​​行によって異なります。 apxs などの SAPI モジュールが構成中に選択されている場合、または --disable-cgi パラメータが使用されている場合、CGI が配置されていない限り、CLI は make install プロセス中に {PREFIX}/bin/php にコピーされます。その位置。したがって、たとえば、configure 行に --with--apxs がある場合、CLI は make install 中に {PREFIX}/bin/php にコピーされます。 CGI 実行可能ファイルのインストールを元に戻したい場合は、make install の後に make install-cli を実行します。あるいは、構成行に --disable-cgi パラメータを追加することもできます。

注:

--enable-cli と --enable-cgi はどちらもデフォルトで有効であるため、設定行に --enable-cli を追加して、実行中に CLI を {PREFIX} にコピーする必要はありません。インストールプロセスを/bin/phpにします。

PHP 4.2.0 と PHP 4.2.3 の間の Windows 配布パッケージでは、CLI のファイル名は php-cli.exe で、同じフォルダー内の php.exe は CGI です。 PHP 4.3.0 バージョン以降、Windows 配布パッケージの CLI 実行ファイルは php.exe となり、cli という名前の別のフォルダー、つまり cli/php.exe に配置されます。 PHP 5 では、CLI はホーム フォルダーに php.exe として存在し、CGI バージョンは php-cgi.exe と呼ばれます。

PHP 5 以降では、php-win.exe という名前の新しいファイルがパッケージとともにリリースされます。これは CLI バージョンと同等ですが、php-win は何も出力しないため、コンソールは提供されません (「DOS ウィンドウ」はポップアップしません)。このアプローチは php-gtk に似ています。 --enable-cli-win32 オプションを使用して構成する必要があります。

注: 使用している SAPI はどのようにしてわかりますか?

コマンドラインで php -v を実行して、php が CGI か CLI かを確認します。関数 php_sapi_name() と定数 PHP_SAPI を参照してください。

注:

Unix のマニュアル ページが PHP 4.3.2 に追加されました。コマンドラインに「man php」と入力して表示できます。

CLI SAPI と他の CLI SAPI モジュールの大きな違いは次のとおりです:

CGI SAPI とは異なり、その出力にはヘッダー情報がありません。 CGI SAPI には HTTP ヘッダー情報を抑制するメソッドが用意されていますが、CLI SAPI には HTTP ヘッダー情報の出力を有効にする同様のメソッドはありません。 CLI はデフォルトで Quiet モードで起動しますが、互換性を確保するために、-q および --no-header パラメータは下位互換性のために保持されており、古い CGI スクリプトの使用が可能です。実行中、作業ディレクトリはスクリプトの現在のディレクトリに変更されません (CGI モードと互換性を持たせるために -C および --no-chdir パラメータを使用できます)。エラー発生時に平文エラーメッセージ(HTML形式ではない)を出力します。

CLI SAPI は、php.ini の特定の設定を強制的にオーバーライドします。これは、これらの設定がシェル環境では無意味であるためです。

php.ini設定オプションをオーバーライドする

オプションを設定する

CLI SAPIデフォルト値

備考

html_errors FALSE 意味のないHTMLタグはエラーメッセージを非常に乱雑にするため、シェルの下のエラーメッセージを読んでください。非常に難しい。したがって、このオプションのデフォルト値を FALSE に変更します。

implicit_flush TRUE コマンド ライン モードでは、print と echo からのすべての出力が、バッファリング操作なしですぐに出力に書き込まれます。標準出力を遅延または制御したい場合でも、出力バッファリング設定を使用できます。

max_execution_time 0 (無限値) シェル環境で PHP を使用する無限の可能性を考慮して、最大実行時間は無限値に設定されます。 Web 用に開発されたアプリケーションの実行には数秒しかかかりませんが、シェル アプリケーションの実行にはさらに長い時間がかかる場合があります。

register_argc_argv TRUE この設定が TRUE であるため、argc (アプリケーションに渡される引数の数) と argv (実際の引数を含む配列) は CLI SAPI で常にアクセス可能になります。 PHP 4.3.0 以降、CLI SAPI を使用する場合、PHP 変数 $argc および $argv が登録され、対応する値に設定されています。以前のバージョンでは、CGI またはモジュール バージョンでのこれら 2 つの変数の確立は、PHP 設定オプション register_globals を on に設定することに依存していました。 version および register_globals 設定に加えて、$_SERVER または $HTTP_SERVER_VARS を呼び出すことでいつでもアクセスできます。例: $_SERVER['argv']

注:

これらの設定は、設定ファイル php.ini またはその他の指定されたファイル内の他の値に初期化することはできません。これらのデフォルト値は、他のすべての設定ファイルが解析された後の変更に制限されます。ただし、それらの値はプログラムの実行中に変更できます (ただし、これらの設定はその実行中のプロセスにとっては意味がありません)。

シェル環境での作業を容易にするために、次の定数を定義しました:

CLI 固有の定数

定数名

説明

STDIN stdin を指すオープンストリーム。次のメソッドで呼び出すことができます:

<?php
    $stdin = fopen(&#39;php://stdin&#39;, &#39;r&#39;);
?>

stdin から行を読み取りたい場合は、

<?php
$line = trim(fgets(STDIN)); // 从 STDIN 读取一行
fscanf(STDIN, "%d\n", $number); // 从 STDIN 读取数字
?>

を使用できます。 STDOUT stdout を指すオープン ストリーム。次のように呼び出すことができます:

<?php    
$stdout = fopen(&#39;php://stdout&#39;, &#39;w&#39;);
?>

STDERR stderr を指すオープンストリーム。次の方法で呼び出すことができます:

<?php   
    $stderr = fopen(&#39;php://stderr&#39;, &#39;w&#39;);
?>

上記の定数を使用すると、stderr を指すストリームを自分で作成する必要はありません。単にこれらの定数を使用してストリームを指すものを置き換えることができます。これらのストリームを自分で閉じる必要はありません。PHP これらの操作は自動的に完了します。

CLI SAPI は、現在のディレクトリを、実行スクリプトが配置されているディレクトリに変更しません。次の例は、このモジュールと CGI SAPI モジュールの違いを示しています:

php -r 'fwrite(STDERR, "stderr\n");'

CGI バージョンを使用する場合、出力は

<?php
    // 名为 test.php 的简单测试程序
    echo getcwd(), "\n";
?>

です。明らかに、PHP が現在のディレクトリを、実行したばかりのスクリプトが配置されているディレクトリに変更することがわかります。 。

CLI SAPI モードを使用すると、次のことが得られます:

$ pwd
/tmp
$ php-cgi -f another_directory/test.php
/tmp/another_directory

これにより、PHP を使用してシェル ツールを作成するときに非常に便利になります。

注:

コマンドラインでの実行時に CGI SAPI に -C パラメータを追加して、CLI SAPI 機能をサポートさせることができます。

以下は、PHP バイナリ ファイル (つまり、php.exe プログラム) によって提供されるコマンド ライン モード オプションのパラメータです。 -h パラメータを指定して PHP コマンドを実行すると、いつでもこれらのパラメータを照会できます。

$ pwd
/tmp
$ php -q another_directory/test.php
/tmp

CLI SAPI モジュールには、PHP コードを実行するための次の 3 つの異なる方法があります:

PHP に指定されたファイルを実行させます。

Usage: php [options] [-f] <file> [--] [args...]
       php [options] -r <code> [--] [args...]
       php [options] [-B <begin_code>] -R <code> [-E <end_code>] [--] [args...]
       php [options] [-B <begin_code>] -F <file> [-E <end_code>] [--] [args...]
       php [options] -- [args...]
       php [options] -a
  -a               Run interactively
  -c <path>|<file> Look for php.ini file in this directory
  -n               No php.ini file will be used
  -d foo[=bar]     Define INI entry foo with value &#39;bar&#39;
  -e               Generate extended information for debugger/profiler
  -f <file>        Parse <file>.
  -h               This help
  -i               PHP information
  -l               Syntax check only (lint)
  -m               Show compiled in modules
  -r <code>        Run PHP <code> without using script tags <?..?>
  -B <begin_code>  Run PHP <begin_code> before processing input lines
  -R <code>        Run PHP <code> for every input line
  -F <file>        Parse and execute <file> for every input line
  -E <end_code>    Run PHP <end_code> after processing all input lines
  -H               Hide any passed arguments from external tools.
  -s               Display colour syntax highlighted source.
  -v               Version number
  -w               Display source with stripped comments and whitespace.
  -z <file>        Load Zend extension <file>.
  args...          Arguments passed to script. Use -- args when first argument
                   starts with - or script is read from stdin

上記のどちらの方法でも (-f パラメーターの有無にかかわらず)、指定された my_script.php ファイルを実行できます。実行するファイルを選択できます。指定した PHP スクリプトには .php 拡張子を付ける必要はありません。任意のファイル名と拡張子を付けることができます。

コマンドラインから直接PHPコードを実行します。

php my_script.php
php -f my_script.php

この方法を使用する場合は、シェル変数の置換と引用符の使用に注意してください。

注:

上記の例をよく読んでください。コードの実行時に開始マーカーと終了マーカーはありません。 -r パラメーターを使用すると、これらのマーカーは不要になり、構文エラーが発生します。

標準入力 (stdin) 経由で実行する必要がある PHP コードを提供します。上記の使用法は非常に強力な機能を提供し、次の例に示すように、PHP コードを動的に生成し、コマンド ラインからこれらのコードを実行することが可能になります:

php -r 'print_r(get_defined_constants());'

上記の 3 つのコード実行方法を同時に使用することはできません。

すべてのシェル アプリケーションと同様、PHP バイナリ (php.exe ファイル) とそれが実行する PHP スクリプトは一連のパラメータを受け入れることができます。 PHP には、スクリプトに渡されるパラメータの数に制限がありません (シェルにはコマンド ラインの文字数に制限がありますが、通常はこの制限を超えることはありません)。スクリプトに渡される引数は、グローバル変数 $argv で使用できます。この配列のインデックスが 0 のメンバーはスクリプトの名前です (PHP コードが標準入力から取得され、-r パラメーターを使用してコマンド ラインから直接実行される場合、名前は「-」になります)。さらに、グローバル変数 $argc には、$argv 配列内のメンバー変数の数が格納されます (スクリプト プログラムに渡されるパラメーターの数ではありません)。

只要传送给脚本的参数不是以 - 符号开头，就无需过多的注意什么。向脚本传送以 - 开头的参数会导致错误，因为 PHP 会认为应该由它自身来处理这些参数。可以用参数列表分隔符 -- 来解决这个问题。在 PHP 解析完参数后，该符号后所有的参数将会被原样传送给脚本程序。

# 以下命令将不会运行 PHP 代码，而只显示 PHP 命令行模式的使用说明：
$ php -r 'var_dump($argv);' -h
Usage: php [options] [-f] <file> [args...]
[...]
# 以下命令将会把“-h”参数传送给脚本程序，PHP 不会显示命令行模式的使用说明：
$ php -r &#39;var_dump($argv);&#39; -- -h
array(2) {
  [0]=>
  string(1) "-"
  [1]=>
  string(2) "-h"
}

除此之外，还有另一个方法将 PHP 用于外壳脚本。可以在写一个脚本，并在第一行以 #!/usr/bin/php 开头，在其后加上以 PHP 开始和结尾标记符包含的正常的 PHP 代码，然后为该文件设置正确的运行属性（例如：chmod +x test）。该方法可以使得该文件能够像外壳脚本或 PERL 脚本一样被直接执行。

#!/usr/bin/php
<?php
    var_dump($argv);
?>

假设改文件名为 test 并被放置在当前目录下，可以做如下操作：

$ chmod +x test
$ ./test -h -- foo
array(4) {
  [0]=>
  string(6) "./test"
  [1]=>
  string(2) "-h"
  [2]=>
  string(2) "--"
  [3]=>
  string(3) "foo"
}

正如所看到的，在向该脚本传送以 - 开头的参数时，脚本仍然能够正常运行。

PHP 4.3.3 以来有效的长选项:

命令行选项

选项名称

长名称

说明

-a    --interactive    交互式运行 PHP。如果编译 PHP 时加入了 Readline 扩展（Windows 下不可用），那将会得到一个很好的外壳，包括一个自动完成的功能（例如可以在键入变量名的时候，按下 TAB 键，PHP 会自动完成该变量名）以及命令历史记录，可以用上下键来访问。历史记录存在 ~/.php_history 文件中。

Note:

通过 auto_prepend_file 和 auto_append_file 包含的文件在此模式下会被解析，但有些限制，例如函数必须在被调用之前定义。

 -c    --php-ini    用该参数，可以指定一个放置 php.ini 文件的目录，或者直接指定一个自定义的 INI 文件（其文件名可以不是 php.ini），例如：

$ php -c /custom/directory/ my_script.php
$ php -c /custom/directory/custom-file.ini my_script.php

如果不指定此选项，PHP 将在默认位置搜索文件。

    -n    --no-php-ini    完全忽略 php.ini。此参数在 PHP 4.3.0 以后有效。    

-d    --define    用该参数可以自行设置任何可以在 php.ini 文件中设置的配置选项的值，其语法为：

-d configuration_directive[=value]

例子（因版面原因而折行显示）：

# 取值部分被省略，将会把配置选项设为 "1"
$ php -d max_execution_time
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(1) "1"
# 取值部分为空白，将会把配置选项设为 ""
php -d max_execution_time=
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(0) ""
# 配置选项将被设置成为任何 '=' 字符之后的值
$  php -d max_execution_time=20
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(2) "20"
$  php
        -d max_execution_time=doesntmakesense
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(15) "doesntmakesense"

-e    --profile-info    激活扩展信息模式，被用于调试／测试。    

-f    --file    解析并运行 -f 选项给定的文件名。该参数为可选参数，可以省略，仅指明需要运行的文件名即可。    

-h and -?    --help and --usage    使用该参数，可以得到完整的命令行参数的列表及这些参数作用的简单描述。    

-i    --info    该命令行参数会调用 phpinfo() 函数并显示出结果。如果 PHP 没有正常工作，建议执行 php -i 命令来查看在信息表格之前或者对应的地方是否有任何错误信息输出。请注意当使用 CGI 摸索时，输出的内容为 HTML 格式，因此输出的信息篇幅较大。    

-l    --syntax-check    该参数提供了对指定 PHP 代码进行语法检查的方便的方法。如果成功，则向标准输出写入 No syntax errors detected in 2334ac29606bf8a170583e4f7533b1f4 字符串，并且外壳返回值为 0。如果失败，则输出 Errors parsing 2334ac29606bf8a170583e4f7533b1f4 以及内部解析器错误信息到标准输出，同时外壳返回值将别设置为 255。该参数将无法检查致命错误（如未定义函数），如果也希望检测致命错误，请使用 -f 参数。

Note:

该参数不能和 -r 一同使用。

 -m    --modules    使用该参数，PHP 将打印出内置以及已加载的 PHP 及 Zend 模块：

$ php -m
[PHP Modules]
xml
tokenizer
standard
session
posix
pcre
overload
mysql
mbstring
ctype
[Zend Modules]

-r    --run    使用该参数可以在命令行内运行单行 PHP 代码。无需加上 PHP 的起始和结束标识符（eaae9fd1bc1dded8026482face6dba9c），否则将会导致语法解析错误。

Note:

使用这种形式的 PHP 时，应注意避免和外壳环境进行的命令行参数替换相冲突。

显示语法解析错误的范例

$ php -r "$foo = get_defined_constants();"
Command line code(1) : Parse error - parse error, unexpected '='

这里的问题在于即使使用了双引号 "，sh/bash 仍然实行了参数替换。由于 $foo 没有被定义，被替换后它所在的位置变成了空字符，因此在运行时，实际被 PHP 读取的代码为：

$ php -r " = get_defined_constants();"

正确的方法是使用单引号 '。在用单引号引用的字符串中，变量不会被 sh/bash 还原成其原值。

$ php -r '$foo = get_defined_constants(); var_dump($foo);'
array(370) {
  ["E_ERROR"]=>
  int(1)
  ["E_WARNING"]=>
  int(2)
  ["E_PARSE"]=>
  int(4)
  ["E_NOTICE"]=>
  int(8)
  ["E_CORE_ERROR"]=>
  [...]

如果使用的外壳不是 sh/bash，可能会碰到更多问题。请将碰到的 Bug 向 » http://bugs.php.net/ 报告。注意，当试图将 shell 变量用到代码中或者使用反斜线时仍然很容易碰到问题。

Note:

-r 在 CLI SAPI 中有效，在 CGI SAPI 中无效。

Note:

此选项只用于非常基本的用途。因此一些配置指令（例如 auto_prepend_file 和 auto_append_file）在此模式下被忽略。

-B    --process-begin    在处理 stdin 之前先执行 PHP 代码。PHP 5 新加。    

-R    --process-code    对每个输入行都执行 PHP 代码。PHP 5 新加。此模式下有两个特殊变量：$argn 和 $argi。$argn 包含 PHP 当前处理的行内容，而 $argi 则包含该行号。    

-F    --process-file    对每个输入行都执行 PHP 文件。PHP 5 新加。    

-E    --process-end    在处理完输入后执行的 PHP 代码。PHP 5 新加。使用 -B ，-R 和 -E 选项来计算一个项目总行数的例子。

$ find my_proj | php -B '$l=0;' -R '$l += count(@file($argn));' -E 'echo "Total Lines: $l\n";'Total Lines: 37328

 -s    --syntax-highlight and --syntax-highlight    显示有语法高亮色彩的源代码。该参数使用内建机制来解析文件并为其生成一个 HTML 高亮版本并将结果写到标准输出。请注意该过程所做的只是生成了一个 ffbe95d20f3893062224282accb13e8f [...] 1cd55414ff5abdfea5dd958e7e547fdd 的 HTML 标记的块，并不包含任何的 HTML 头。

Note:

该选项不能和 -r 参数同时使用。

 -v    --version    将 PHP，PHP SAPI 和 Zend 的版本信息写入标准输出。例如：

$ php -v
PHP 4.3.0 (cli), Copyright (c) 1997-2002 The PHP GroupZend Engine v1.3.0, Copyright (c) 1998-2002 Zend Technologies

   -w    --strip    显示除去了注释和多余空白的源代码。

Note:

该选项不能和 -r 参数同时使用。

    -z    --zend-extension    加载 Zend 扩展库。如果仅给定一个文件名，PHP 将试图从当前系统扩展库的默认路径（在 Linux 系统下，该路径通常由 /etc/ld.so.conf 指定）加载该扩展库。如果用一个绝对路径指定文件名，则不会使用系统的扩展库默认路径。如果用相对路径指定的文件名，则 PHP 仅试图在当前目录的相对目录加载扩展库。    

 PHP 的命令行模式能使得 PHP 脚本能完全独立于 web 服务器单独运行。如果使用 Unix 系统，需要在 PHP 脚本的最前面加上一行特殊的代码，使得它能够被执行，这样系统就能知道用哪个程序去运行该脚本。在 Windows 平台下可以将 php.exe 和 .php 文件的双击属性相关联，也可以编写一个批处理文件来用 PHP 执行脚本。为 Unix 系统增加的第一行代码不会影响该脚本在 Windows 下的运行，因此也可以用该方法编写跨平台的脚本程序。以下是一个简单的 PHP 命令行程序的范例。

Example #1 试图以命令行方式运行的 PHP 脚本（script.php）

#!/usr/bin/php
<?php
if ($argc != 2 || in_array($argv[1], array(&#39;--help&#39;, &#39;-help&#39;, &#39;-h&#39;, &#39;-?&#39;))) {
?>
This is a command line PHP script with one option.
  Usage:
  <?php echo $argv[0]; ?> <option>
  <option> can be some word you would like
  to print out. With the --help, -help, -h,
  or -? options, you can get this help.
<?php
} else {
    echo $argv[1];
}
?>

在以上脚本中，用第一行特殊的代码来指明该文件应该由 PHP 来执行。在这里使用 CLI 的版本，因此不会有 HTTP 头信息输出。在用 PHP 编写命令行应用程序时，可以使用两个参数：$argc 和 $argv。前面一个的值是比参数个数大 1 的整数（运行的脚本本身的名称也被当作一个参数）。第二个是包含有参数的数组，其第一个元素为脚本的名称，下标为数字 0（$argv[0]）。

以上程序中检查了参数的个数是大于 1 个还是小于 1 个。此外如果参数是 --help ，-help ，-h 或 -? 时，打印出帮助信息，并同时动态输出脚本的名称。如果还收到了其它参数，将其显示出来。

如果希望在 Unix 下运行以上脚本，需要使其属性为可执行文件，然后简单的运行 script.php echothis 或 script.php -h。在 Windows 下，可以为此编写一个批处理文件：

Example #2 运行 PHP 命令行脚本的批处理文件（script.bat）

@C:\php\php.exe script.php %1 %2 %3 %

假设将上述程序命名为 script.php，且 CLI 版的 php.exe 文件放置在 c:\php\cli\php.exe，该批处理文件会帮助将附加的参数传给脚本程序：script.bat echothis 或 script.bat -h。