PHP 5.6.0 released

php_sapi_name

(PHP 4 >= 4.0.1, PHP 5)

php_sapi_nameGibt das genutzte Interface zwischen PHP und dem Webserver zurück

Beschreibung

string php_sapi_name ( void )

Gibt einen kleingeschriebenen String zurück, der die Schnittstelle (das Server-API, SAPI) beschreibt, die PHP verwendet. Dieser String 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 genutzt wird. Die möglichen Rückgabewerte sind weiter unten aufgelistet.

Rückgabewerte

Gibt den Schnittstellentyp als kleingeschriebenen String zurück.

Mögliche Werte sind unter anderem aolserver, apache, apache2filter, apache2handler, caudium, cgi (until PHP 5.3), cgi-fcgi, cli, continuity, embed, isapi, litespeed, milter, nsapi, phttpd, pi3web, roxen, thttpd, tux und webjames.

Beispiele

Beispiel #1 php_sapi_name() Beispiel

Dieses Beispiel prüft auf die Teilzeichenkette cgi da es auch cgi-fcgi sein kann.

<?php
$sapi_type 
php_sapi_name();
if (
substr($sapi_type03) == 'cgi') {
    echo 
"Sie benutzen CGI PHP\n";
} else {
    echo 
"Sie benutzen nicht CGI PHP\n";
}
?>

Anmerkungen

Hinweis: Ein alternativer Ansatz

Die PHP Konstante PHP_SAPI hat 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 oder apache2filter definiert sein.

Siehe auch

add a note add a note

User Contributed Notes 3 notes

up
9
michal at roszka dot pl
5 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
6
hajo-p
6 months ago
some not yet mentioned sapi names:

cli-server -> php built-in webserver
srv -> hhvm
up
-2
Ysangkok
6 years ago
This function can also return "cli" if PHP was launched from CLI. Useful if one wants to behave differently when running in console.
To Top