File: env.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (130 lines) | stat: -rw-r--r-- 3,299 bytes parent folder | download
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->

<phpdoc:varentry xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="reserved.variables.environment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" role="noversion">
 <refnamediv>
  <refname>$_ENV</refname>
  <refname>$HTTP_ENV_VARS [deprecated]</refname>
  <refpurpose>Environment variables</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   An associative <type>array</type> of variables passed to the current script
   via the environment method. 
  </para>

  <simpara>
   These variables are imported into PHP's global namespace from the
   environment under which the PHP parser is running. Many are
   provided by the shell under which PHP is running and different
   systems are likely running different kinds of shells, a
   definitive list is impossible. Please see your shell's
   documentation for a list of defined environment variables.
  </simpara>

  <simpara>
   Other environment variables include the CGI variables, placed
   there regardless of whether PHP is running as a server module or
   CGI processor.
  </simpara>

  <simpara>
   <varname>$HTTP_ENV_VARS</varname> contains the same initial
   information, but is not a <link linkend="language.variables.superglobals">superglobal</link>. 
   (Note that <varname>$HTTP_ENV_VARS</varname> and <varname>$_ENV</varname>
   are different variables and that PHP handles them as such)
  </simpara>

 </refsect1>
 

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.1.0</entry>
       <entry>
        Introduced <varname>$_ENV</varname> that deprecated
        <varname>$HTTP_ENV_VARS</varname>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="variable.env.basic">
    <title><varname>$_ENV</varname> example</title>
    <programlisting role="php">
<![CDATA[
<?php
echo 'My username is ' .$_ENV["USER"] . '!';
?>
]]>
    </programlisting>
    <simpara>
     Assuming "bjori" executes this script
    </simpara>
    &example.outputs.similar;
    <screen>
<![CDATA[
My username is bjori!
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  &note.is-superglobal;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>getenv</function></member>
    <member><link linkend="book.filter">The filter extension</link></member>
   </simplelist>
  </para>
 </refsect1>

</phpdoc:varentry>
 
<!-- 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
-->