archived-doc-de/reference/apache/functions/apache-note.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 1.0 Reviewer: samesch -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apache_note</refname>
  <refpurpose>Liefert und setzt Mitteilungen für Apache-Anfragen</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>apache_note</methodname>
   <methodparam><type>string</type><parameter>note_name</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>note_value</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Diese Funktion ist ein Wrapper für die Apache-Befehle
   <literal>table_get</literal> und <literal>table_set</literal>. Damit lässt
   sich die Apachetabelle für Mitteilungen bearbeiten, die erstellt wird, wenn
   eine Anfrage übermittelt wird. Der Sinn dieser Tabelle ist es, die
   Kommunikation zwischen Apachemodulen zu ermöglichen.
  </para>
  <para>
   Der primäre Anwendungsfall für <function>apache_note</function> ist die
   Übergabe von Informationen von einem Modul an ein anderes während der
   Abarbeitung einer bestimmten Anfrage.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>note_name</parameter></term>
     <listitem>
      <para>
       Der Name der Mitteilung.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>note_value</parameter></term>
     <listitem>
      <para>
       Der Wert der Mitteilung.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Wenn <parameter>note_value</parameter> weggelassen wird oder &null; ist,
   gibt sie den aktuellen Wert der Mitteilung <literal>note_name</literal>
   zurück. Andernfalls setzt sie den Wert der Mitteilung
   <literal>note_name</literal> auf <literal>note_value</literal> und gibt den
   vorigen Wert der Mitteilung <literal>note_name</literal> zurück. Wenn die
   Mitteilung nicht abgerufen werden kann, wird &false; zurückgegeben.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>note_value</parameter> ist jetzt nullable now (akzeptiert
       den &null;-Wert).
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Übergeben von Informationen zwischen PHP und Perl</title>
    <programlisting role="php">
<![CDATA[
<?php

apache_note('name', 'Fredrik Ekengren');

// Perl-Skript aufrufen
virtual("/perl/some_script.pl");

$result = apache_note("resultdata");
?>
]]>
    </programlisting>
    <programlisting role="perl">
<![CDATA[
# Hole das Apache-Anfrage-Objekt
my $r = Apache->request()->main();

# Hole die übergebenen Daten
my $name = $r->notes('name');

# beliebige Verarbeitung

# Reiche das Ergebnis an PHP zurück
$r->notes('resultdata', $result);
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Werte in access.log aufzeichnen</title>
    <programlisting role="php">
<![CDATA[
<?php

apache_note('sessionID', session_id());

?>
]]>
    </programlisting>
    <programlisting role="apache">
<![CDATA[
# "%{sessionID}n" kann in der LogFormat-Direktive verwendet werden
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>virtual</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
-->