php_sapi_name

(PHP 4 >= 4.0.1, PHP 5, PHP 7)

php_sapi_name — 返回 web 服务器和 PHP 之间的接口类型

说明

php_sapi_name ( void ) : string

返回描述 PHP 所使用的接口类型（the Server API, SAPI）的小写字符串。例如，CLI 的 PHP 下这个字符串会是 "cli"，Apache 下可能会有几个不同的值，取决于具体使用的 SAPI。以下列出了可能的值。

返回值

返回接口类型的小写字符串。

尽管不够全面，可能返回的值包括了 aolserver、apache、 apache2filter、apache2handler、 caudium、cgi （直到 PHP 5.3）, cgi-fcgi、cli、 cli-server、 continuity、embed、fpm-fcgi、 isapi、litespeed、 milter、nsapi、 phttpd、pi3web、roxen、 thttpd、tux 和 webjames。

范例

Example #1 php_sapi_name() 例子

以下例子检测了子字符串 cgi，因为它也有可能会是 cgi-fcgi。


<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
    echo "You are using CGI PHP\n";
} else {
    echo "You are not using CGI PHP\n";
}
?>

注释

Note: 另一种方法

PHP 常量 PHP_SAPI 具有和 php_sapi_name() 相同的值。

Tip

一个潜在的疑难问题

定义的 SAPI 可能不够明显，比如它可能定义为 apache2handler 或 apache2filter，而不是 apache

参见

PHP_SAPI

User Contributed Notes

anonymous 16-Sep-2015 02:50


php_sapi_name (which is equal to PHP_SAPI) can either be cgi or any other cgi mod (dependent on which mod you are using)-



Examples: 

'fpm-fcgi'

'cgi-fcgi'

[...]

hajo-p 03-Feb-2014 10:58


some not yet mentioned sapi names:



cli-server -> php built-in webserver

srv -> hhvm

michal at roszka dot pl 26-Mar-2009 01:13


The php_sapi_name() function is extremely useful when you want to determine the type of interface. There is, however, one more gotcha you need to be aware of while designing your application or deploying it to an unknown server.



Whenever something depends on the type of interface, make sure your check is conclusive. Especially when you want to distinguish the command line interface (CLI) from the common gateway interface (CGI).



Note, that the php-cgi binary can be called from the command line, from a shell script or as a cron job as well! If so, the php_sapi_name() will always return the same value (i.e. "cgi-fcgi") instead of "cli" which you could expect.



Bad things happen to good people. Do not always expect /usr/bin/php to be a link to php-cli binary.



Luckily the contents of the $_SERVER and the $_ENV superglobal arrays depends on whether the php-cgi binary is called from the command line interface (by a shell script, by the cron, etc.) or by some HTTP server (i.e. lighttpd).



<?php

var_dump($_SERVER);

?>



Try to call php-cgi binary from the command line interface and then via HTTP request and compare the output of the script above. There will be plenty options to satisfy almost everyone.



For the sake of security remember, that contents of the $_SERVER and the $_ENV superglobal arrays (as well as $_GET, $_POST, $_COOKIE, $_FILES and $_REQUEST) should be considered tainted.