mirror of
https://github.com/php/doc-ja.git
synced 2026-04-24 16:38:16 +02:00
Yoshinari Takaoka
167 lines
4.8 KiB
XML
167 lines
4.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 8dd14a886c7e954cef181c374b6f05cc7149e643 Maintainer: hirokawa Status: ready -->
|
|
<!-- CREDITS: takagi -->
|
|
<refentry xml:id="function.getenv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>getenv</refname>
|
|
<refpurpose>環境変数の値を取得する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>getenv</methodname>
|
|
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>local_only</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>getenv</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
環境変数の値を取得します。
|
|
</para>
|
|
<para>
|
|
<function>phpinfo</function> を使えば、すべての環境変数の一覧を見ることができます。
|
|
これらの変数の多くは、
|
|
<link xlink:href="&url.rfc;3875">RFC 3875</link> の
|
|
section 4.1, "Request Meta-Variables" に挙げられているものです。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>varname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
変数の名前。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>local_only</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
true に設定すると、(OS または putenv により設定された)
|
|
ローカルの環境変数のみを返します。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<parameter>varname</parameter> が示す環境変数の値を返し、
|
|
環境変数 <parameter>varname</parameter> が存在しない場合は&false;を返します。
|
|
<parameter>varname</parameter> が省略された場合、
|
|
すべての環境変数は連想配列として返されます。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>7.1.0</entry>
|
|
<entry>
|
|
<parameter>varname</parameter> は、すべての環境変数の連想配列を取得するために
|
|
省略することができるようになりました。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.0.9</entry>
|
|
<entry>
|
|
<parameter>local_only</parameter> パラメーターが追加されました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>getenv</function> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// getenv() の使用例
|
|
$ip = getenv('REMOTE_ADDR');
|
|
|
|
// または単純にスーパーグローバル（$_SERVER または $_ENV）を使用します
|
|
$ip = $_SERVER['REMOTE_ADDR'];
|
|
|
|
// SAPI により設定されたか、または putenv により変更されたかどうかを無視して
|
|
// 環境変数の値を安全に取得します。
|
|
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<warning>
|
|
<para>
|
|
PHP が Fast CGI のような SAPI で実行中の場合、
|
|
同じ名前のローカル環境変数を設定するために <function>putenv</function> が使用されても、
|
|
この関数は SAPI により設定された環境変数の値を常に返します。
|
|
ローカル設定された環境変数の値を返すには、
|
|
<parameter>local_only</parameter> パラメーターを使用してください。
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>putenv</function></member>
|
|
<member><function>apache_getenv</function></member>
|
|
<member><link linkend="language.variables.superglobals">スーパーグローバル</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
|
|
-->
|