function.apache-note.html 6.35 KB
<!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>Setzt und liest 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 Funktionen</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> &mdash; <span class="dc-title">Setzt und liest Apache Request Notes</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.apache-note-description">
  <h3 class="title">Beschreibung</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"> = &quot;&quot;</span></span>
  ] )</div>

  <p class="para rdfs-comment">
   Diese Funktion ist ein Wrapper für das <em>table_get</em> und
   <em>table_set</em> von Apache. Sie editiert die Notestabelle, die
   während eines Requests existiert. Der Sinn dieser Tabelle ist es, die
   Kommunikation zwischen Apachemodulen zu ermöglichen.
  </p>
  <p class="para">
   Der primäre Anwendungsfall für <span class="function"><strong>apache_note()</strong></span> ist die
   Übergabe von Informationen von einem Modul an ein anderes während der
   Abarbeitung eines bestimmten Requests.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.apache-note-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <p class="para">
   <dl>

    
     <dt>
<code class="parameter">note_name</code></dt>

     <dd>

      <p class="para">
       Der Name der Note.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">note_value</code></dt>

     <dd>

      <p class="para">
       Der Wert der Note.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.apache-note-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   Wenn die Funktion mit einem Argument aufgerufen wird, gibt sie den aktuellen
   Wert der Note <em>note_name</em> zurück. Wird sie mit zwei
   Argumenten aufgerufen, setzt sie den Wert der Note <em>note_name</em>
   auf <em>note_value</em> und gibt den vorigen Wert der Note
   <em>note_name</em> zurück. Wenn die Note nicht angesprochen werden
   kann, wird <strong><code>FALSE</code></strong> zurückgegeben.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.apache-note-examples">
  <h3 class="title">Beispiele</h3>
  <p class="para">
   <div class="example" id="example-4715">
    <p><strong>Beispiel #1 Übergeben von Informationen zwischen PHP und Perl</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'Fredrik&nbsp;Ekengren'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;Perl-Skript&nbsp;aufrufen<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&nbsp;</span><span style="color: #007700">=&nbsp;</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">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents">
<div class="perlcode"><pre class="perlcode"># Hole das Apache Request Objekt
my $r = Apache-&gt;request()-&gt;main();

# Hole die übergebenen Daten
my $name = $r-&gt;notes(&#039;name&#039;);

# beliebige Verarbeitung

# Reiche das Ergebnis an PHP zurück
$r-&gt;notes(&#039;resultdata&#039;, $result);</pre>
</div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-4716">
    <p><strong>Beispiel #2 Werte in access.log loggen</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'sessionID'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">session_id</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents">
<div class="apachecode"><pre class="apachecode"># &quot;%{sessionID}n&quot; kann in der LogFormat-Direktive verwendet werden</pre>
</div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.apache-note-seealso">
  <h3 class="title">Siehe auch</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> - F&uuml;hrt eine Apache-Unteranfrage durch</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 Funktionen</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>