php-doc-en/reference/apache/functions/apache-setenv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.7 -->
<refentry xml:id="function.apache-setenv" xmlns="http://docbook.org/ns/docbook">
 <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><initializer>false</initializer></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 
    <varname>$_SERVER</varname>
    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:"~/.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
-->