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.
php_sapi_name
(PHP 4 >= 4.0.1, PHP 5, PHP 7)
php_sapi_name — Повертає тип інтерфейса між веб-сервером та PHP
Опис
string php_sapi_name
( void
)
Повертає рядок в нижньому регістрі, що описує тип інтерфейса (Server API, SAPI), який використовує PHP. Наприклад, у PHP CLI цим рядком буде "cli", тоді як при роботі PHP з 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.
Приклади
Приклад #1 Використання php_sapi_name()
В цьому прикладі перевіряється підрядок cgi, оскільки він може мати значення cgi-fcgi.
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "Ви використовуєте CGI PHP\n";
} else {
echo "Ви не використовуєте CGI PHP\n";
}
?>
Примітки
Зауваження: Альтернативний підхід
PHP-константа
PHP_SAPIмає таке ж значення, як і повернене значення функцією php_sapi_name().
Підказка
Можна зловитись
Визначення SAPI може бути неточним, оскільки, наприклад, замість apache, його може бути визначено як apache2handler чи apache2filter.
add a note
User Contributed Notes 4 notes
michal at roszka dot pl ¶
15 years ago
hajo-p ¶
10 years ago
some not yet mentioned sapi names:
cli-server -> php built-in webserver
srv -> hhvm
michael at butlerpc dot net ¶
3 years ago
When using nginx-unit with PHP, the sapi name seems to be "cli-server"
