1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.7 -->
<refentry id="function.apache-setenv">
<refnamediv>
<refname>apache_setenv</refname>
<refpurpose>Set an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apache_setenv</methodname>
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_setenv</function> sets the value of the Apache
environment variable specified by
<parameter>variable</parameter>.
</para>
<note>
<para>
When setting an Apache environment variable, the corresponding
<link linkend="reserved.variables.server">$_SERVER</link>
variable is not changed.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variable</parameter></term>
<listitem>
<para>
The environment variable that's being set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The new <parameter>variable</parameter> value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>walk_to_top</parameter></term>
<listitem>
<para>
Whether to set the top-level variable available to all Apache layers.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Setting an Apache environment variable using <function>apache_setenv</function></title>
<programlisting role="php">
<![CDATA[
<?php
apache_setenv("EXAMPLE_VAR", "Example Value");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>apache_setenv</function> can be paired up with
<function>apache_getenv</function> across separate pages or for setting
variables to pass to Server Side Includes (.shtml) that have been
included in PHP scripts.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apache_getenv</function></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:"../../../../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
-->
|
