php_logo_guid
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_sapi_name — Devuelve el tipo de interfaz entre el servidor web y PHP
Descripción
string php_sapi_name
( void
)
Devuelve una cadena en minúsculas que describe el tipo de interfaz entre el servidor web y PHP (API de Servidor, SAPI). En PHP CGI, esta cadena es "cgi", en mod_php para Apache, esta cadena es "apache" y así sucesivamente.
Valores retornados
Devuelve el tipo de interfaz, como una cadena en minúsculas.
Ejemplos
Example #1 Ejemplo de php_sapi_name()
<?php
$tipo_sapi = php_sapi_name();
if (substr($tipo_sapi, 0, 3) == 'cgi') {
echo "Está usando PHP CGI\n";
} else {
echo "No está usando PHP CGI\n";
}
?>
add a note
User Contributed Notesphp_sapi_name
michal at roszka dot pl
26-Mar-2009 09:13
26-Mar-2009 09:13
Ysangkok
27-Aug-2008 09:34
27-Aug-2008 09:34
This function can also return "cli" if PHP was launched from CLI. Useful if one wants to behave differently when running in console.