vrana Sun Aug 22 06:14:34 2004 EDT
Modified files:
/phpdoc/en/reference/apache/functions apache-getenv.xml
apache-setenv.xml
Log:
Documentation by mazzanet
http://cvs.php.net/diff.php/phpdoc/en/reference/apache/functions/apache-getenv.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/apache/functions/apache-getenv.xml
diff -u phpdoc/en/reference/apache/functions/apache-getenv.xml:1.2
phpdoc/en/reference/apache/functions/apache-getenv.xml:1.3
--- phpdoc/en/reference/apache/functions/apache-getenv.xml:1.2 Sat Jan 17 06:43:05
2004
+++ phpdoc/en/reference/apache/functions/apache-getenv.xml Sun Aug 22 06:14:34
2004
@@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.apache-getenv">
<refnamediv>
<refname>apache_getenv</refname>
- <refpurpose>
- Get an Apache subprocess_env variable
- </refpurpose>
+ <refpurpose>Get an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -14,7 +12,29 @@
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam
choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ <para>
+ <function>apache_getenv</function> returns the value of the Apache
+ environment variable specified by <parameter>variable</parameter>, or
+ &false; on failure.
+ </para>
+ <example>
+ <title><function>apache_getenv</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$ret = apache_getenv("SERVER_ADDR");
+echo $ret;
+?>
+]]>
+ </programlisting>
+ <para>
+ The example above shows how to retrieve the value of the Apache
+ environment variable "SERVER_ADDR".
+ </para>
+ </example>
+ <para>
+ See also <function>apache_setenv</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/apache/functions/apache-setenv.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/apache/functions/apache-setenv.xml
diff -u phpdoc/en/reference/apache/functions/apache-setenv.xml:1.2
phpdoc/en/reference/apache/functions/apache-setenv.xml:1.3
--- phpdoc/en/reference/apache/functions/apache-setenv.xml:1.2 Wed Apr 17 02:36:20
2002
+++ phpdoc/en/reference/apache/functions/apache-setenv.xml Sun Aug 22 06:14:34
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.7 -->
<refentry id="function.apache-setenv">
<refnamediv>
@@ -8,14 +8,41 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</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>
+ <methodsynopsis>
+ <type>int</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>
- &warn.undocumented.func;
+ <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 $_SERVER
+ variable is not changed.
+ </para>
+ </note>
+ <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>
+ <function>apache_setenv</function> can be paired up with
+ <function>apache_getenv</function> across seperate pages or for setting
+ variables to pass to Server Side Includes (.shtml) that have been
+ included in PHP scripts.
+ </para>
+ <para>
+ See also <function>apache_getenv</function>.
</para>
</refsect1>
</refentry>
