-
Notifications
You must be signed in to change notification settings - Fork 50
Expand file tree
/
Copy pathgetenv.xml
More file actions
170 lines (160 loc) · 5.04 KB
/
getenv.xml
File metadata and controls
170 lines (160 loc) · 5.04 KB
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1299a9808782769bba9f6a48bf52cb1c68182e78 Maintainer: hholzgra Status: ready -->
<refentry xml:id="function.getenv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>getenv</refname>
<refpurpose>Liefert den Wert einer einzelnen oder aller Umgebungsvariablen</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>array</type><type>false</type></type><methodname>getenv</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>local_only</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Gibt den Wert einer einzelnen oder aller Umgebungsvariablen zurück.
</para>
<para>
Eine Liste aller Umgebungsvariablen lässt sich mit der Funktion
<function>phpinfo</function> anzeigen. Viele dieser Variablen sind im
<link xlink:href="&url.rfc;3875">RFC 3875</link>, insbesondere im Abschnitt
4.1, "Request Meta-Variables", aufgeführt.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Der Variablenname als &string; oder &null;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local_only</parameter></term>
<listitem>
<para>
Bei &true; werden nur lokale Umgebungsvariablen zurückgegeben, die vom
Betriebsystem oder durch putenv() gesetzt wurden. Es hat nur dann eine
Auswirkung, wenn <parameter>name</parameter> ein &string; ist.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Gibt den Wert der Umgebungsvariable <parameter>varname</parameter> zurück
oder &false;, wenn die Umgebungsvariable <parameter>name</parameter> nicht
existiert. Ist <parameter>name</parameter> &null;, werden alle
Umgebungsvariablen als assoziatives <type>Array</type> zurückgegeben.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Der Parameter <parameter>name</parameter> ist nun nullable (akzeptiert
den &null;-Wert).
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
Der Parameter <parameter>name</parameter> kann nun ausgelassen werden,
um ein assoziatives <type>Array</type> aller Umgebungsvariablen
abzurufen.
</entry>
</row>
<row>
<entry>7.0.9</entry>
<entry>
Der Parameter <parameter>local_only</parameter> wurde hinzugefügt.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>getenv</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
// Verwendung von getenv() ...
$ip = getenv('REMOTE_ADDR');
// ... oder einfach eines superglobalen Arrays ($_SERVER oder $_ENV)
$ip = $_SERVER['REMOTE_ADDR'];
// Sicheres Lesen eines Wertes einer Umgebungsvariablen, wobei ignoriert wird,
// ob sie durch die SAPI gesetzt oder durch putenv geändert wurde
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
Wird PHP in einer SAPI wie Fast CGI ausgeführt, gibt diese Funktion immer
den Wert einer Umgebungsvariablenzurück, die von der SAPI gesetzt wurde,
selbst wenn <function>putenv</function> verwendet wurde, um eine lokale
Umgebungsvariable mit dem selben Namen zu setzen. Verwenden Sie
<parameter>local_only</parameter>, um den Wert einer lokal gesetzten
Umgebungsvariable zurückzugeben.
</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">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
-->