php-sapi-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8dd14a886c7e954cef181c374b6f05cc7149e643 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.php-sapi-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>php_sapi_name</refname>
  <refpurpose>ウェブサーバーと PHP の間のインターフェイスの型を返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>php_sapi_name</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   PHP が使用しているインターフェイス (サーバー API、SAPI)
   の型を小文字の文字列で返します。たとえば、CLI 版の PHP ではこの文字列は
   "cli" となります。Apache と組み合わせて使用している場合は、
   実際に使用している SAPI によってさまざまな結果となります。
   返されうる値の一覧を以下にあげます。
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   インターフェイスの型を小文字の文字列で返します。
   &return.falseforfailure;
  </para>
  <para>
   これがすべてではありませんが、以下のような値が返されます。
   <literal>apache</literal>, 
   <literal>apache2handler</literal>, 
   <literal>cgi</literal> (PHP 5.3 まで), 
   <literal>cgi-fcgi</literal>, <literal>cli</literal>, <literal>cli-server</literal>,
   <literal>embed</literal>, <literal>fpm-fcgi</literal>,
   <literal>litespeed</literal>, 
   <literal>phpdbg</literal>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>php_sapi_name</function> の例</title>
    <para>
     この例では、文字列の一部に <literal>cgi</literal>
     が含まれるかどうかを調べています。というのも
     <literal>cgi-fcgi</literal> となることもあり得るからです。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
    echo "CGI 版の PHP を使用しています\n";
} else {
    echo "CGI 版の PHP を使用していません\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>別の方法</title>
   <para>
    PHP の定数 <constant>PHP_SAPI</constant> は、
    <function>php_sapi_name</function> と同じ値となります。
   </para>
  </note>
  <tip>
   <title>失敗しがちな点</title>
   <para>
    定義されている <acronym>SAPI</acronym> は、わかりやすいものばかりではないかもしれません。
    たとえば <literal>apache</literal> の場合は
    <literal>apache2handler</literal>
    と定義されることもあります。
   </para>
  </tip>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="reserved.constants.core">PHP_SAPI</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->