php_sapi_name

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

php_sapi_name — Devuelve el tipo de interfaz utilizada entre el servidor web y PHP

Descripción

php_sapi_name(): string|false

Devuelve una cadena en minúsculas que describe el tipo de interfaz (la API, SAPI del servidor) que PHP utiliza. Por ejemplo, en PHP CLI, esta cadena será "cli" mientras que con Apache, puede tener varios valores diferentes según el SAPI exacto utilizado. Las posibles valores se listan a continuación.

Parámetros

Esta función no contiene ningún parámetro.

Valores devueltos

Devuelve el tipo de la interfaz, en forma de string en minúsculas, o false si ocurre un error.

A continuación se muestra una lista no exhaustiva de los posibles valores : apache, apache2handler, cgi (hasta PHP 5.3), cgi-fcgi, cli, cli-server, embed, fpm-fcgi, litespeed, phpdbg.

Ejemplos

Ejemplo #1 Ejemplo con php_sapi_name()

Este ejemplo busca la subcadena cgi ya que también puede ser cgi-fcgi.

<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
    echo "Se utiliza CGI PHP\n";
} else {
    echo "No se utiliza CGI PHP\n";
}
?>

Notas

Nota: Un enfoque alternativo

La constante PHP PHP_SAPI tiene un valor idéntico a php_sapi_name().

Sugerencia

Un comportamiento inesperado

El SAPI definido no debe ser ambiguo, ya que por ejemplo, en lugar de apache, puede ser definido como apache2handler.

Ver también

PHP_SAPI

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

michal at roszka dot pl ¶

16 years ago

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.

down

hajo-p ¶

11 years ago

some not yet mentioned sapi names:

cli-server -> php built-in webserver
srv -> hhvm

down

Anonymous ¶

2 years ago

Note: When using Litespeed with CPanel, the SAPI will be "litespeed" and not contain "cgi".

＋add a note