archived-doc-de/reference/sqlite/functions/sqlite-create-function.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: lapistano Status: ready -->
<refentry xml:id="function.sqlite-create-function" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_create_function</refname>
  <refname>SQLiteDatabase->createFunction</refname>
  <refpurpose>
   Registriert eine "reguläre" nutzerdefinierte Funktion für den Gebrauch in SQL-Befehlen
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>sqlite_create_function</methodname>
   <methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
   <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
   <methodparam><type>callback</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>num_args</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>Objektorientierter Stil (Methode):</para>
  <classsynopsis>
   <ooclass><classname>SQLiteDatabase</classname></ooclass>
   <methodsynopsis>
    <type>void</type><methodname>createFunction</methodname>
    <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
    <methodparam><type>callback</type><parameter>callback</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>num_args</parameter><initializer>-1</initializer></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   <function>sqlite_create_function</function> erlaubt Ihnen, eine 
   PHP-Funktion in SQLite als <acronym>UDF</acronym> 
   (User Defined Function = Nutzerdefinierte Funktion) zu erzeugen, 
   so dass diese direkt in SQL-Befehlen genutzt werden kann.
  </para>
  <para>
   UDF sind in jedem SQL-Befehl nutzbar, der Funktionsaufrufe wie SELECT,
   UPDATE oder auch Trigger beinhalten kann.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbhandle</parameter></term>
     <listitem>
      <para>
       Die Ressource des SQLite-Ergebnisses, erzeugt von
       <function>sqlite_open</function> wenn in prozeduralem Kontext genutzt.
       Dieser Parameter wird nicht benötigt, wenn die objektorientierte
       Notation genutzt wird.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>function_name</parameter></term>
     <listitem>
      <para>
       Name der Funktion, wie er in den SQL-Befehlen genutzt werden soll.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       Eine beliebige gültige PHP-Funktion oder Methode, die aufgerufen
       werden soll, um die SQL-Funktion abzuarbeiten.
      </para>
      <note>
       <simpara>
        "Callback"-Funktionen sollten einen Variablentyp zurückgeben, der von 
        SQLite erkannt wird (z.B. <link linkend="language.types.intro">Skalare</link>).
       </simpara>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>num_args</parameter></term>
     <listitem>
      <para>
       Hinweis für den SQLite-Parser auf die Parameterzahl der "Callback"-Funktion.
       Es wird empfohlen, diesen Wert zu definieren, wenn Ihre Funktion immer
       mit der gleichen Parameterzahl arbeitet.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &sqlite.param-compat;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>sqlite_create_function</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
function md5_and_reverse($string) 
{
    return strrev(md5($string));
}

if ($dbhandle = sqlite_open('mysqlitedb', 0666, $sqliteerror)) {
    
    sqlite_create_function($dbhandle, 'md5rev', 'md5_and_reverse', 1);
    
    $sql  = 'SELECT md5rev(filename) FROM files';
    $rows = sqlite_array_query($dbhandle, $sql);
} else {
    echo 'Fehler beim Öffnen der Datenbankverbindung: ' . $sqliteerror;
    exit;
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   In diesem Beispiel haben wir eine Funktion, die die md5-Summe eines
   Strings berechnet und dann rückwärts ausliefert. Wenn der SQL-Befehl 
   durchgeführt wird, liefert er den Wert der Spalte "filename" durch unsere 
   Funktion transformiert zurück. Die Daten, die in <parameter>$rows</parameter>
   stehen, enhalten also die bereits gewandelten Daten.
  </para>
  <para>
   Die Eleganz dieser Technik ist das Vermeiden des Durchfahrens des kompletten
   Abfrageergebnisses mit einer &foreach;-Schleife.
  </para>
  <para>
   PHP registriert außerdem automatisch eine spezielle Funktion
   mit dem Namen <literal>php</literal>, wenn die Datenbank
   <parameter>dbhandle</parameter> zum ersten Mal geöffnet wird.
   Diese Funktion kann genutzt werden, um eine beliebige PHP-Funktion
   aufzurufen, ohne dass sie zunächst für SQLite erzeugt werden muss.
  </para>
  <para>
   <example>
    <title>Beispiel zur Nutzung einer beliebigen PHP-Funktion</title>
    <programlisting role="php">
<![CDATA[
<?php
$rows = sqlite_array_query($dbhandle, "SELECT php('md5', filename) from files");
?>
]]>
    </programlisting>
    <para>
     In diesem Beispiel wird die Funktion <function>md5</function> für
     jeden Eintrag der Spalte <literal>filename</literal> in der Datenbank
     aufgerufen und das Ergebnis in <parameter>$rows</parameter> geschrieben.
    </para>
   </example>
  </para>
  <note>
   <para>
    Aus Performanzgründen kodiert/dekodiert PHP nicht automatisch die 
    Binärdaten der Spalten, die in die UDF/aus der UDF geliefert werden. 
    Daher müssen Sie die Parameter und Rückgabewerte der Funktion jeweils selbst 
    wandeln. Die Funktionen <function>sqlite_udf_encode_binary</function>
    und <function>sqlite_udf_decode_binary</function> sind dabei behilflich.
   </para>
  </note>
  <tip>
   <para>
    Es wird empfohlen, die UDFs nicht für Binärdaten zu nutzen, wenn 
    Ihre Anwendung eine hohe Geschwindigkeit aufweisen soll.
   </para>
  </tip>
  <tip>
   <para>
    <function>sqlite_create_function</function> und
    <function>sqlite_create_aggregate</function> können dazu genutzt werden,
    native SQlite-Funktionen zu überschreiben.
   </para>
  </tip>
 </refsect1>

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