File: putenv.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (81 lines) | stat: -rw-r--r-- 2,708 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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
  <refentry id="function.putenv">
   <refnamediv>
    <refname>putenv</refname>
    <refpurpose>Sets the value of an environment variable</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>putenv</methodname>
      <methodparam><type>string</type><parameter>setting</parameter></methodparam>
     </methodsynopsis>
    <para>
     Adds <parameter>setting</parameter> to the server environment.  The
     environment variable will only exist for the duration of the current
     request. At the end of the request the environment is restored to its
     original state.
    </para>
    <para>
     Setting certain environment variables may be a potential security breach.
     The <literal>safe_mode_allowed_env_vars</literal> directive contains a
     comma-delimited list of prefixes. In Safe Mode, the user may only alter
     environment variables whose names begin with the prefixes supplied by
     this directive. By default, users will only be able to set environment
     variables that begin with <literal>PHP_</literal> (e.g.
     <literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, PHP
     will let the user modify ANY environment variable!
    </para>
    <para>
     The <literal>safe_mode_protected_env_vars</literal> directive contains a
     comma-delimited list of environment variables, that the end user won't be
     able to change using <function>putenv</function>.  These variables will
     be protected even if <literal>safe_mode_allowed_env_vars</literal> is set
     to allow to change them.
    </para>
    <warning>
     <para>
      These directives have only effect when <link
      linkend="features.safe-mode">safe-mode</link> itself is enabled!
     </para>
    </warning>
    <para>
     <example>
      <title>Setting an environment variable</title>
      <programlisting role="php">
<![CDATA[
<?php
putenv("UNIQID=$uniqid");
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>getenv</function>.
    </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
-->