從版本 4.3.0 開始，PHP 提供了一種新類型的 SAPI（Server Application Programming Interface，服務端應用編程端口）支持，名為 CLI，意為 Command Line Interface，即命令行接口。顧名思義，該 SAPI 模塊主要用作 PHP 的開發外殼應用。CLI SAPI 和其它 SAPI 模塊相比有很多的不同之處，我們將在本章中詳細闡述。值得一提的是，CLI 和 CGI 是不同的 SAPI，盡管它們之間有很多共同的行為。

CLI SAPI 最先是隨 PHP 4.2.0 版本發布的，但仍舊只是一個實驗性的版本，並需要在運行 ./configure

從 PHP 4.3.0開始，CLI/CGI 二進制執行文件的文件名、位置和是否存在會根據 PHP 在您系統上的安裝而不同。在默認情況下，當運行 make 時，CGI 和 CLI 都會被編譯並且分別放置在您 PHP 源文件目錄的 sapi/cgi/php和 sapi/cli/php 下。您可以註意到兩個文件都被命名為了 php。在 make install 的過程中會發生什麽取決於您的配置行。如果在配置的時候選擇了一個 SAPI 模塊，如 apxs，或者使用了 --disable-cgi

註: 由於 --enable-cli 和 --enable-cgi 同時默認有效，因此，您不必再配置行中加上 --enable-cli

來使得 CLI 在 make install 過程中被拷貝到 {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。

這是哪個 SAPI？: 在命令外殼下，運行 php -v 便能得知該 php 是 CGI 還是 CLI。請參考函數 php_sapi_name() 以及常量 PHP_SAPI。

註: 在 PHP 4.3.2 中加入了 UNIX 的 man 頁面。可以在你的命令外殼下鍵入 man php 來查看。

以下為 CLI SAPI 和其它 SAPI 模塊相比的顯著區別：

• 與 CGI SAPI 不同，其輸出沒有任何頭信息。

  盡管 CGI SAPI 提供了取消 HTTP 頭信息的方法，但在 CLI SAPI 中並不存在類似的方法以開啟 HTTP 頭信息的輸出。

  CLI 默認以安靜模式開始，但為了保證兼容性， -q 參數使得您可以使用舊的 CGI 腳本。

  在運行時，不會把工作目錄改為腳本的當前目錄。（您可以使用 -C 參數來兼容 CGI 模式）。

  出錯時輸出純文本的錯誤信息（非 HTML 格式）。

• CLI SAPI 強制更改了 php.ini 中的某些設置，因為這些設置在外殼環境下是沒有意義的。

  表格 23-1. 被更改的 php.ini 設置選項

  設置選項	CLI SAPI 默認值	備註
  html_errors	FALSE	無意義的 HTML 標記符會使得出錯信息很淩亂，所以在外殼下閱讀報錯信息是十分困難的。因此將該選項的默認值改為 FALSE。
  implicit_flush	TRUE	在命令行模式下，所有來自 print() 和 echo() 的輸出將被立即寫到輸出端，而不作任何地緩沖操作。如果您希望延緩或控制標準輸出，您仍然可以使用 output buffering 設置項。
  max_execution_time	0 （無限值）	鑒於在外殼環境下使用 PHP 的無窮的可能性，最大運行時間被設置為了無限值。為 WEB 開發的應用程序可能只需運行幾秒鐘時間，而外殼應用程序的運行時間可能會長的多。
  register_argc_argv	TRUE	由於該設置為 TRUE，您將總是可以在 CLI SAPI 中訪問到 argc（傳送給應用程序參數的個數）和 argv（包含有實際參數的數組）。 對於 PHP 4.3.0，在使用 CLI SAPI 時，PHP 變量 $argc 和 $argv 已被註冊並且設定了對應的值。而在這之前的版本，這兩個變量在 CGI 或者 模塊 版本中的建立依賴於將 PHP 的設置選項 register_globals 設為 on。除了版本和 register_globals 設定以外，您可以隨時通過調用 $_SERVER 或者 $HTTP_SERVER_VARS來訪問它們。例如：$_SERVER[‘argv‘]

  註: 這些設置無法在設置文件 php.ini 或任何指定的其它文件中被初始化為其它值。這些默認值被限制在所有其它的設置文件被解析後改變。不過，它們的值可以在程序運行的過程中被改變（盡管對於該運行過程來說，這些設置項是沒有意義的）。

• 為了減輕外殼環境下的工作，我們定義了如下常量：

  表格 23-2. CLI 專用常量

  常量名稱	描 述
  STDIN	一個已打開的指向 stdin 的流。您可以用如下方法來調用： $stdin = fopen(‘php://stdin‘, ‘r‘);
  STDOUT	一個已打開的指向 stdout 的流。您可以用如下方式來調用： $stdout = fopen(‘php://stdout‘, ‘w‘);
  STDERR	一個已打開的指向 stderr 的流。您可以用如下方式來調用： $stderr = fopen(‘php://stderr‘, ‘w‘);

  有了以上常量，您就無需自己建立指向諸如 stderr 的流，只需簡單的使用這些常量來代替流指向：

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

  您無需自己來關閉這些流，PHP 會自動完成這些操作。

• CLI SAPI 不會將當前目錄改為已運行的腳本所在的目錄。

  以下範例顯示了本模塊與 CGI SAPI 模塊之間的不同：

  <?php /* Our simple test application named test.php*/ echo getcwd(), "\n"; ?>

  在使用 CGI 版本時，其輸出為

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

  我們明顯可以看到 PHP 將當前目錄改成了剛剛運行過的腳本所在的目錄。

  使用 CLI SAPI 模式，我們得到：

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

  這使得我們在利用 PHP 編寫外殼工具時獲得了很大的便利。

  註: 您可以在命令行運行時給 CGI SAPI 加上 -C 參數，使其支持 CLI SAPI 的功能。

以下是 PHP 二進制文件（即 php.exe 程序）提供的命令行模式的選項參數，您隨時可以通過 PHP -h 命令來查詢這些參數。

Usage: php [options] [-f] <file> [args...]
       php [options] -r <code> [args...]
       php [options] [-- args...]
  -s               Display colour syntax highlighted source.
  -w               Display source with stripped comments and whitespace.
  -f <file>        Parse <file>.
  -v               Version number
  -c <path>|<file> Look for php.ini file in this directory
  -a               Run interactively
  -d foo[=bar]     Define INI entry foo with value ‘bar‘
  -e               Generate extended information for debugger/profiler
  -z <file>        Load Zend extension <file>.
  -l               Syntax check only (lint)
  -m               Show compiled in modules
  -i               PHP information
  -r <code>        Run PHP <code> without using script tags <?..?>
  -h               This help

  args...          Arguments passed to script. Use -- args when first argument 
                   starts with - or script is read from stdin

CLI SAPI 模塊有以下三種不同的方法來獲取您要運行的 PHP 代碼：

1. 讓 PHP 運行指定文件。

   php my_script.php php -f my_script.php

   以上兩種方法（使用或不使用 -f 參數）都能夠運行給定的 my_script.php 文件。您可以選擇任何文件來運行，您指定的 PHP 腳本並非必須要以 .php 為擴展名，它們可以有任意的文件名和擴展名。

2. 在命令行直接運行 PHP 代碼。

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

   在使用這種方法時，請您註意外殼變量的替代及引號的使用。

   註: 請仔細閱讀以上範例，在運行代碼時沒有開始和結束的標記符！加上 -r 參數後，這些標記符是不需要的，加上它們會導致語法錯誤。

3. 通過標準輸入（stdin）提供需要運行的 PHP 代碼。

   以上用法給我們提供了非常強大的功能，使得我們可以如下範例所示，動態地生成 PHP 代碼並通過命令行運行這些代碼：

   $ some_application | some_filter | php | sort -u >final_output.txt

以上三種運行代碼的方法不能同時使用。

和所有的外殼應用程序一樣，PHP 的二進制文件（php.exe 文件）及其運行的 PHP 腳本能夠接受一系列的參數。PHP 沒有限制傳送給腳本程序的參數的個數（外殼程序對命令行的字符數有限制，但您通常都不會超過該限制）。傳遞給您腳本的參數可在全局變量 $argv 中獲取。該數組中下標為零的成員為腳本的名稱（當 PHP 代碼來自標準輸入獲直接用 -r 參數以命令行方式運行時，該名稱為“-”）。另外，全局變量 $argc 存有 $argv 數組中成員變量的個數（而非傳送給腳本程序的參數的個數）。

只要您傳送給您腳本的參數不是以 - 符號開頭，您就無需過多的註意什麽。向您的腳本傳送以 - 開頭的參數會導致錯誤，因為 PHP 會認為應該由它自身來處理這些參數。您可以用參數列表分隔符 -- 來解決這個問題。在 PHP解析完參數後，該符號後所有的參數將會被原樣傳送給您的腳本程序。

# 以下命令將不會運行 PHP 代碼，而只顯示 PHP 命令行模式的使用說明：
$ php -r ‘var_dump($argv);‘ -h
Usage: php [options] [-f] <file> [args...]
[...]

# 以下命令將會把“-h”參數傳送給腳本程序，PHP 不會顯示命令行模式的使用說明：
$ php -r ‘var_dump($argv);‘ -- -h
array(2) {
  [0]=>
  string(1) "-"
  [1]=>
  string(2) "-h"
}

除此之外，我們還有另一個方法將 PHP 用於外殼腳本。您可以在寫一個腳本，並在第一行以 #!/usr/bin/php 開頭，在其後加上以 PHP 開始和結尾標記符包含的正常的 PHP 代碼，然後為該文件設置正確的運行屬性。該方法可以使得該文件能夠像外殼腳本或 PERL 腳本一樣被直接執行。

假設改文件名為 test 並被放置在當前目錄下，我們可以做如下操作：

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

正如您所看到的，在您向該腳本傳送以 - 開頭的參數時，腳本仍然能夠正常運行。

表格 23-3. 命令行選項

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

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

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

-d configuration_directive[=value]

# Ommiting the value part will set the given configuration directive to "1"
$ php -d max_execution_time 
       -r ‘$foo = ini_get("max_execution_time"); var_dump($foo);‘
string(1) "1"

# Passing an empty value part will set the configuration directive to ""
php -d max_execution_time= 
       -r ‘$foo = ini_get("max_execution_time"); var_dump($foo);‘
string(0) ""

# The configuration directive will be set to anything passed after the ‘=‘ character
$  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"

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

[Zend Modules]

PHP 的命令行模式能使得 PHP 腳本能完全獨立於 WEB 服務器單獨運行。如果您使用 Unix 系統，您需要在您的 PHP 腳本的最前面加上一行特殊的代碼，使得它能夠被執行，這樣系統就能知道用什麽樣的程序要運行該腳本。在 Windows 平臺下您可以將 php.exe 和 .php 文件的雙擊屬性相關聯，您也可以編寫一個批處理文件來用 PHP 執行腳本。為 Unix 系統增加的第一行代碼不會影響該腳本在 Windows 下的運行，因此您也可以用該方法編寫跨平臺的腳本程序。以下是一個簡單的PHP 命令行程序的範例。

在以上腳本中，我們用第一行特殊的代碼來指明該文件應該由 PHP 來執行。我們在這裏使用 CLI 的版本，因此不會有 HTTP 頭信息輸出。在您用 PHP 編寫命令行應用程序時，您可以使用兩個參數：$argc 和 $argv。前面一個的值是比參數個數大 1 的整數（運行的腳本本身的名稱也被當作一個參數）。第二個時包含有參數的數組，其第一個元素為腳本的名稱，下標為數字 0（$argv[0]）。

在以上程序中我們檢查了參數的個數是大於 1 個還是小於 1 個。即時參數是 --help、-help、-h 或 -?，我們仍然打印出幫助信息，並同時動態輸出腳本的名稱。如果還收到了其它參數，我們也把它們顯示出來。

如果您希望在 Unix 下運行以上腳本，您需要使得它成為可執行腳本，然後簡單的運行 script.php echothis 或 script.php -h。在 Windows 下，您可以為此編寫一個批處理文件：

@c:\php\cli\php.exe script.php %1 %2 %3 %4

假設您將上述程序命名為 script.php，且您的 CLI php.exe 文件放置在 c:\php\cli\php.exe，該批處理文件會幫助您將附加的參數傳給腳本程序： script.bat echothis 或 script.bat -h。