Re: [PHP-DEV] apache + notes From: David Sklar (sklar <email protected>)
Date: 07/14/98

Stig S. Bakken wrote:
>
> [David Sklar <sklar <email protected>>]
> |
> | Here's a diff against 3.0.2-dev for a function to get and set values in
> | apache's "notes" table. This can be especially useful for logging -- i
> | do cookie based authentication via PHP, so once my PHP figures out the
> | username from the various things in the cookie, it can stick it in a
> | note, and then mod_log_config can grab the note and log the username
> | with the request.
>
> It has been added. You don't happen to feel inclined to write some
> docs while you're at it? :-)

OK, here's my shot at properly understanding SGML... :)

  <refentry id="function.apache_note">
   <refnamediv>
    <refname>apache_note</refname>
    <refpurpose>Get and set apache request notes</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>apache_note</function></funcdef>
     <paramdef>string <parameter>note_name</parameter></paramdef>
     <paramdef>string
<parameter><optional>note_value</optional></parameter></paramdef>
    </funcsynopsis>
    <para>
     <Function>apache_note</function> is an Apache-specific function
     which gets and sets values in a request's <literal>notes</literal>
     table. If called with one argument, it returns the current value of
     note <literal>note_name</literal>. If called with two arguments, it
     sets the value of note <literal>note_name</literal> to
     <literal>note_value</literal> and returns the previous value of
note
     <literal>note_name</literal>.
   </refsect1>
  </refentry>

-dave