Source of: /manual/en/function.apache-getenv.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.apache.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.apache-getenv.php',
1 => 'apache_getenv',
),
'up' =>
array (
0 => 'ref.apache.php',
1 => 'Apache Functions',
),
'prev' =>
array (
0 => 'function.apache-get-version.php',
1 => 'apache_get_version',
),
'next' =>
array (
0 => 'function.apache-lookup-uri.php',
1 => 'apache_lookup_uri',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.apache-getenv" class="refentry">
<div class="refnamediv">
<h1 class="refname">apache_getenv</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">apache_getenv</span> — <span class="dc-title">Get an Apache subprocess_env variable</span></p>
</div>
<a name="function.apache-getenv.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>apache_getenv</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$variable</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$walk_to_top</tt></span>
] )</div>
<p class="para rdfs-comment">
Get an Apache environment variable as specified by
<i><tt class="parameter">variable</tt></i>
.
</p>
<p class="para">
This function requires Apache 2 otherwise it's undefined.
</p>
</div>
<a name="function.apache-getenv.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">variable</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The Apache environment variable
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">walk_to_top</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Whether to get the top-level variable available to all Apache layers.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.apache-getenv.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The value of the Apache environment variable on success, or <b><tt class="constant">FALSE</tt></b> on
failure
</p>
</div>
<a name="function.apache-getenv.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>apache_getenv()</b> example</b></p>
<div class="example-contents para"><p>
The example above shows how to retrieve the value of the Apache
environment variable <var class="varname">SERVER_ADDR</var>.
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">apache_getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">"SERVER_ADDR"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$ret</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
42.24.42.240
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.apache-getenv.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.apache-setenv.php" class="function" rel="rdfs-seeAlso">apache_setenv()</a> - Set an Apache subprocess_env variable</li>
<li class="member"><a href="function.getenv.php" class="function" rel="rdfs-seeAlso">getenv()</a> - Gets the value of an environment variable</li>
<li class="member"><a href="language.variables.superglobals.php" class="link">Superglobals</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
