PHP 8.3.7 Released!

php_sapi_name

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

php_sapi_nameRetorna o tipo de interface entre o servidor web e o PHP

Descrição

php_sapi_name(): string

Retorna uma string em minúsculas que descreve o tipo de interface (API do Servidor, SAPI) que o PHP está usando. Por exemplo, no PHP CLI esta string será "cli" e no Apache poderá ter vários valores diferentes dependendo da SAPI exata sendo usada. Os valores possíveis estão listados abaixo.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Retorna o tipo de interface como uma string em minúsculasing ou false em caso de falha.

Embora não seja uma lista exaustiva, os valores possíveis incluem apache, apache2handler, cgi (até o PHP 5.3), cgi-fcgi, cli, cli-server, embed, fpm-fcgi, litespeed, phpdbg.

Exemplos

Exemplo #1 Exemplo de php_sapi_name()

Este exemplo procura pela sub-string cgi porque a interface também pode ser cgi-fcgi.

<?php
$sapi_type
= php_sapi_name();
if (
substr($sapi_type, 0, 3) == 'cgi') {
echo
"Você está usando o PHP CGI.\n";
} else {
echo
"Você não está usando o PHP CGI.\n";
}
?>

Notas

Nota: Uma abordagem alternativa

A constante PHP_SAPI do PHP tem o mesmo valor retornado pela função php_sapi_name().

Dica

Uma potencial armadilha

A SAPI definida pode não ser óbvia porque, por exemplo, ao invés de apache ela pode estar definida como apache2handler.

Veja Também

add a note

User Contributed Notes 5 notes

up
41
michal at roszka dot pl
15 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.
up
29
hajo-p
10 years ago
some not yet mentioned sapi names:

cli-server -> php built-in webserver
srv -> hhvm
up
-1
Anonymous
1 year ago
Note: When using Litespeed with CPanel, the SAPI will be "litespeed" and not contain "cgi".
up
-10
michael at butlerpc dot net
3 years ago
When using nginx-unit with PHP, the sapi name seems to be "cli-server"
up
-44
anonymous
8 years ago
php_sapi_name (which is equal to PHP_SAPI) can either be cgi or any other cgi mod (dependent on which mod you are using)-

Examples:
'fpm-fcgi'
'cgi-fcgi'
[...]
To Top