<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get and set apache request notes</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apache-lookup-uri.html">apache_lookup_uri</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apache-request-headers.html">apache_request_headers</a></div>
<div class="up"><a href="ref.apache.html">Apache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.apache-note" class="refentry">
<div class="refnamediv">
<h1 class="refname">apache_note</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">apache_note</span> — <span class="dc-title">Get and set apache request notes</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apache-note-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>apache_note</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$note_name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$note_value</code><span class="initializer"> = ""</span></span>
] )</div>
<p class="para rdfs-comment">
This function is a wrapper for Apache's <em>table_get</em> and
<em>table_set</em>. It edits the table of notes that exists
during a request. The table's purpose is to allow Apache modules to
communicate.
</p>
<p class="para">
The main use for <span class="function"><strong>apache_note()</strong></span> is to pass information
from one module to another within the same request.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apache-note-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">note_name</code></em></span>
<dd>
<p class="para">
The name of the note.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">note_value</code></em></span>
<dd>
<p class="para">
The value of the note.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apache-note-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If called with one argument, it returns the current value of note
<em>note_name</em>. If called with two arguments, it
sets the value of note <em>note_name</em> to
<em>note_value</em> and returns the previous value of
note <em>note_name</em>.
If the note cannot be retrieved, <strong><code>FALSE</code></strong> is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apache-note-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4754">
<p><strong>Example #1 Passing information between PHP and Perl</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Fredrik Ekengren'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Call perl script<br /></span><span style="color: #0000BB">virtual</span><span style="color: #007700">(</span><span style="color: #DD0000">"/perl/some_script.pl"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">"resultdata"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="perlcode"><pre class="perlcode"># Get Apache request object
my $r = Apache->request()->main();
# Get passed data
my $name = $r->notes('name');
# some processing
# Pass result back to PHP
$r->notes('resultdata', $result);</pre>
</div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-4755">
<p><strong>Example #2 Logging values in access.log</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'sessionID'</span><span style="color: #007700">, </span><span style="color: #0000BB">session_id</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="apachecode"><pre class="apachecode"># "%{sessionID}n" can be used in the LogFormat directive</pre>
</div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.apache-note-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.virtual.html" class="function" rel="rdfs-seeAlso">virtual()</a> - Perform an Apache sub-request</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apache-lookup-uri.html">apache_lookup_uri</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apache-request-headers.html">apache_request_headers</a></div>
<div class="up"><a href="ref.apache.html">Apache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
