uTools-Manuals/docs/php/getenv.html
2019-04-08 23:22:26 +08:00

157 lines
6.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>获取一个环境变量的值</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.getenv" class="refentry">
<div class="refnamediv">
<h1 class="refname">getenv</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">getenv</span> &mdash; <span class="dc-title">获取一个环境变量的值</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.getenv-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>getenv</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$varname</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$local_only</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] ) : <span class="type">string</span></div>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>getenv</strong></span>
( <span class="methodparam">void</span>
) : <span class="type">array</span></div>
<p class="para rdfs-comment">
获取一个环境变量的值。
</p>
<p class="para">
使用 <span class="function"><a href="phpinfo.html" class="function">phpinfo()</a></span> 你可以看到所有环境变量的列表。
这些变量很多都在 <a href="http://www.faqs.org/rfcs/rfc3875" class="link external">&raquo;&nbsp;RFC 3875</a> 的范围之内,
尤其是章节4.1&quot;Request Meta-Variables&quot;
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.getenv-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">varname</code></dt>
<dd>
<p class="para">
变量名。
</p>
</dd>
<dt>
<code class="parameter">local_only</code></dt>
<dd>
<p class="para">
设置为 true 以仅返回本地环境变量(由操作系统或 <span class="function"><a href="putenv.html" class="function">putenv()</a></span> 设置)。
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.getenv-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
返回环境变量 <code class="parameter">varname</code> 的值,
如果环境变量 <code class="parameter">varname</code> 不存在则返回 <strong><code>FALSE</code></strong>
如果省略 <code class="parameter">varname</code>,则所有环境变量都将作为关联数组 <span class="type"><a href="language.types.array.html" class="type array">array</a></span> 返回。
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.getenv-changelog">
<h3 class="title">更新日志</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.1.0</td>
<td>
现在可以省略 <code class="parameter">varname</code> 来检索所有环境变量的关联数组 <span class="type"><a href="language.types.array.html" class="type array">array</a></span>
</td>
</tr>
<tr>
<td>5.5.38, 5.6.24, 7.0.9</td>
<td>
添加 <code class="parameter">local_only</code> 参数。
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 notes" id="refsect1-function.getenv-notes">
<h3 class="title">注释</h3>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
如果 PHP 在诸如 Fast CGI 之类的 SAPI 中运行,则此函数将始终返回由 SAPI 设置的环境变量的值,即使已使用 <span class="function"><a href="putenv.html" class="function">putenv()</a></span> 来设置同名的本地环境变量。使用 <code class="parameter">local_only</code> 参数返回本地设置的环境变量的值。
</p>
</div>
</div>
<div class="refsect1 examples" id="refsect1-function.getenv-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-505">
<p><strong>Example #1 <span class="function"><strong>getenv()</strong></span> 例子</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;getenv()&nbsp;使用示例<br /></span><span style="color: #0000BB">$ip&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;或简单仅使用全局变量($_SERVER&nbsp;&nbsp;$_ENV<br /></span><span style="color: #0000BB">$ip&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$_SERVER</span><span style="color: #007700">[</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">];<br /><br /></span><span style="color: #FF8000">//&nbsp;安全地获取环境变量,忽略通过&nbsp;SAPI&nbsp;&nbsp;putenv&nbsp;修改的值<br /></span><span style="color: #0000BB">$ip&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">true</span><span style="color: #007700">)&nbsp;?:&nbsp;</span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">)<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.getenv-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="putenv.html" class="function" rel="rdfs-seeAlso">putenv()</a> - 设置环境变量的值</span></li>
<li class="member"><span class="function"><a href="apache_getenv.html" class="function" rel="rdfs-seeAlso">apache_getenv()</a> - 获取 Apache subprocess_env 变量</span></li>
<li class="member"><a href="language.variables.superglobals.html" class="link">超全局变量</a></li>
</ul>
</p>
</div>
</div></div></div></body></html>