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 8)
php_sapi_name — Liefert das zwischen PHP und Webserver verwendete Interface
Beschreibung
Gibt eine Zeichenkette in Kleinbuchstaben zurück, die die von PHP verwendete Schnittstelle (das Server-API, SAPI) beschreibt. Diese Zeichenkette ist z. B. "cli" für den PHP-Kommandozeileninterpreter CLI, während beim Einsatz mit Apache unterschiedliche Werte zurückgegeben werden können, je nachdem welches SAPI verwendet wird. Die möglichen Rückgabewerte sind weiter unten aufgelistet.
Parameter-Liste
Diese Funktion besitzt keine Parameter.
Rückgabewerte
Gibt den Schnittstellentyp als Zeichenkette in Kleinbuchstaben zurück.
Bei einem Fehler wird false zurückgegeben.
Mögliche Werte sind unter anderem apache,
apache2handler, cgi (bis PHP 5.3),
cgi-fcgi, cli,
cli-server, embed,
fpm-fcgi, litespeed und
phpdbg.
Beispiele
Beispiel #1 php_sapi_name()-Beispiel
Dieses Beispiel prüft auf die Teilzeichenkette cgi, da
es auch cgi-fcgi sein könnte.
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "Sie benutzen CGI-PHP\n";
} else {
echo "Sie benutzen nicht CGI-PHP\n";
}
?>Anmerkungen
Hinweis: Ein alternativer Ansatz
Die PHP-Konstante
PHP_SAPIhat den gleichen Wert wie php_sapi_name().
Tipp
Eine mögliche Überraschung
Die definierte SAPI muss nicht naheliegend sein, denn
zum Beispiel anstatt als apache kann sie als
apache2handler definiert sein.
add a note
User Contributed Notes 5 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
Anonymous ¶
1 year ago
Note: When using Litespeed with CPanel, the SAPI will be "litespeed" and not contain "cgi".
michael at butlerpc dot net ¶
3 years ago
When using nginx-unit with PHP, the sapi name seems to be "cli-server"
