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 — Devuelve el tipo de interfaz que hay entre PHP y el servidor
Descripción
php_sapi_name(): string
Devuelve una cadena en minúsculas que describe el tipo de interfaz (la API de Servidor, SAPI) que está utilizando PHP. Por ejemplo, en PHP CLI esta cadena será "cli" mientras que en Apache podría tener varios valores diferentes dependiendo de la SAPI que se utilice. Más abajo se enumeran los posibles valores.
Valores devueltos
Devuelve el tipo de interfaz, como cadena de texto en minúsculas.
Pese a no ser una lista completa, los posibles valores incluyen
aolserver, apache,
apache2filter, apache2handler,
caudium, cgi (hasta PHP 5.3),
cgi-fcgi, cli, cli-server,
continuity, embed, fpm-fcgi,
isapi, litespeed,
milter, nsapi,
phttpd, pi3web, roxen,
thttpd, tux, y webjames.
Ejemplos
Ejemplo #1 Ejemplo de php_sapi_name()
Este ejemplo comprueba si está la cadena cgi,
ya que podría darse un nombre como cgi-fcgi.
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "Está usando PHP CGI\n";
} else {
echo "No está usando PHP CGI\n";
}
?>Notas
Nota: Una forma alternativa
La constante de PHP
PHP_SAPIcontiene el mismo valor que php_sapi_name().
Sugerencia
Posible malentendido
Podría no ser evidente cuál es la SAPI en uso, ya que, por ejemplo,
en lugar de apache podría aparecer definida como
apache2handler o como apache2filter.
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"
