Source of: /manual/en/function.apache-setenv.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-setenv.php',
1 => 'apache_setenv',
),
'up' =>
array (
0 => 'ref.apache.php',
1 => 'Apache Functions',
),
'prev' =>
array (
0 => 'function.apache-response-headers.php',
1 => 'apache_response_headers',
),
'next' =>
array (
0 => 'function.ascii2ebcdic.php',
1 => 'ascii2ebcdic',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.apache-setenv" class="refentry">
<div class="refnamediv">
<h1 class="refname">apache_setenv</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">apache_setenv</span> — <span class="dc-title">Set an Apache subprocess_env variable</span></p>
</div>
<a name="function.apache-setenv.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>apache_setenv</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$variable</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$value</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$walk_to_top</tt><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
<b>apache_setenv()</b> sets the value of the Apache
environment variable specified by
<i><tt class="parameter">variable</tt></i>
.
</p>
<blockquote><p><b class="note">Note</b>:
When setting an Apache environment variable, the corresponding
<var class="varname"><a href="reserved.variables.server.php" class="classname">$_SERVER</a></var>
variable is not changed.
<br />
</p></blockquote>
</div>
<a name="function.apache-setenv.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 environment variable that's being set.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">value</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The new <i><tt class="parameter">variable</tt></i>
value.
</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 set the top-level variable available to all Apache layers.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.apache-setenv.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.apache-setenv.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Setting an Apache environment variable using <b>apache_setenv()</b></b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />apache_setenv</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXAMPLE_VAR"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Example Value"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.apache-setenv.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>:
<b>apache_setenv()</b> can be paired up with
<a href="function.apache-getenv.php" class="function">apache_getenv()</a> across separate pages or for setting
variables to pass to Server Side Includes (.shtml) that have been
included in PHP scripts.
<br />
</p></blockquote>
</div>
<a name="function.apache-setenv.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-getenv.php" class="function" rel="rdfs-seeAlso">apache_getenv()</a> - Get an Apache subprocess_env variable</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
