<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdo-sqlite.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'pdo-sqlite.createfunction.php',
    1 => 'Pdo\\Sqlite::createFunction',
    2 => 'Registriert eine benutzerdefinierte Funktion zur Verwendung in SQL-Anweisungen',
  ),
  'up' => 
  array (
    0 => 'class.pdo-sqlite.php',
    1 => 'Pdo\\Sqlite',
  ),
  'prev' => 
  array (
    0 => 'pdo-sqlite.createcollation.php',
    1 => 'Pdo\\Sqlite::createCollation',
  ),
  'next' => 
  array (
    0 => 'pdo-sqlite.loadextension.php',
    1 => 'Pdo\\Sqlite::loadExtension',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'de',
    'path' => 'reference/pdo_sqlite/pdo/sqlite/createfunction.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pdo-sqlite.createfunction" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Pdo\Sqlite::createFunction</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.4.0)</p><p class="refpurpose"><span class="refname">Pdo\Sqlite::createFunction</span> &mdash; <span class="dc-title">
   Registriert eine benutzerdefinierte Funktion zur Verwendung in SQL-Anweisungen
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-pdo-sqlite.createfunction-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Pdo\Sqlite::createFunction</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$function_name</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$num_args</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   This method allows PHP function to be registered with SQLite as a
   user-defined function, so that it can be called within SQL queries.
   The defined function can be used in any SQL query that allows function calls,
   for example <code class="literal">SELECT</code>, <code class="literal">UPDATE</code>, or triggers.
  </p>
  <div class="tip"><strong class="tip">Tipp</strong>
   <p class="simpara">
    By using this method it is possible to override native SQL functions.
   </p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-pdo-sqlite.createfunction-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <dl>
   
    <dt><code class="parameter">function_name</code></dt>
    <dd>
     <span class="simpara">
      Der Name der Funktion, der in SQL-Anweisungen genutzt wird.
     </span>
    </dd>
   
   
    <dt><code class="parameter">callback</code></dt>
    <dd>
     <span class="simpara">
      Die Callback-Funktion, die die definierte SQL-Funktion verarbeitet.
     </span>
     <blockquote class="note"><p><strong class="note">Hinweis</strong>: 
      <span class="simpara">
       Die Callback-Funktionen sollten einen Typ zurückgeben, der von SQLite
       verstanden wird, z. B. den
       <a href="language.types.intro.php" class="link">Skalar-Typ</a>.
      </span>
     </p></blockquote>
     <p class="para">
      Diese Funktion muss wie folgt definiert werden:
      <div class="methodsynopsis dc-description">
       <span class="methodname"><span class="replaceable">callback</span></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">...$values</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

      <dl>
       
        <dt><code class="parameter">value</code></dt>
        <dd>
         <p class="para">
          Das erste Argument, das an die SQL-Funktion übergeben wird.
         </p>
        </dd>
       
       
        <dt><code class="parameter">values</code></dt>
        <dd>
         <p class="para">
          Weitere Argumente, die an die SQL-Funktion übergeben werden.
         </p>
        </dd>
       
      </dl>
     </p>
    </dd>
   
   
    <dt><code class="parameter">num_args</code></dt>
    <dd>
     <span class="simpara">
      Die Anzahl von Argumenten, die die SQL-Funktion erwartet.
      Ist dieser Parameter <code class="literal">-1</code>, dann kann die SQL-Funktion
      eine beliebige Anzahl von Argumenten annehmen.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      Eine Bitmaske von Flags.
      Zurzeit wird nur <strong><code><a href="class.pdo-sqlite.php#pdo-sqlite.constants.deterministic">Pdo\Sqlite::DETERMINISTIC</a></code></strong>
      unterstützt, das angibt, dass die Funktion für dieselben Eingaben
      innerhalb einer einzelnen SQL-Anweisung immer dasselbe Ergebnis
      zurückgibt.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pdo-sqlite.createfunction-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="simpara">
   Gibt bei Erfolg <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> zurück. Bei einem Fehler wird <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> zurückgegeben.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-pdo-sqlite.createfunction-examples">
  <h3 class="title">Beispiele</h3>
  <div class="example" id="pdo-sqlite.createfunction.example.basic">
   <p><strong>Beispiel #1 <span class="methodname"><strong>Pdo\Sqlite::createFunction()</strong></span>-Beispiel</strong></p>
   <div class="example-contents"><p>
    In diesem Beispiel wird eine Funktion verwendet, die die SHA256-Prüfsumme
    einer Zeichenkette berechnet und anschließend umgekehrt. Wenn die
    SQL-Anweisung ausgeführt wird, gibt sie den Wert des von unserer Funktion
    umgewandelten Dateinamens zurück.
    Die in <var class="varname">$zeilen</var> zurückgegebenen Daten enthalten das
    verarbeitete Ergebnis.
   </p></div>
   <div class="example-contents"><p>
    Das Schöne an dieser Technik ist, dass das Ergebnis der Abfrage nicht in
    einer <a href="control-structures.foreach.php" class="link"><code class="literal">foreach</code></a>-Schleife nachbearbeitet werden muss.
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">sha256_und_umkehren</span><span style="color: #007700">(</span><span style="color: #0000BB">$string</span><span style="color: #007700">)<br />{<br />    return </span><span style="color: #0000BB">strrev</span><span style="color: #007700">(</span><span style="color: #0000BB">hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #0000BB">$string</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= new </span><span style="color: #0000BB">Pdo\Sqlite</span><span style="color: #007700">(</span><span style="color: #DD0000">'sqlite::sqlitedb'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createFunction</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256rev'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sha256_und_umkehren'</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zeilen </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT sha256rev(dateiname) FROM dateien'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">fetchAll</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-pdo-sqlite.createfunction-seealso">
  <h3 class="title">Siehe auch</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="pdo-sqlite.createaggregate.php" class="methodname" rel="rdfs-seeAlso">Pdo\Sqlite::createAggregate()</a> - Registriert eine benutzerdefinierte Aggregationsfunktion zur Verwendung in
   SQL-Anweisungen</span></li>
   <li><span class="methodname"><a href="pdo-sqlite.createcollation.php" class="methodname" rel="rdfs-seeAlso">Pdo\Sqlite::createCollation()</a> - Registers a user-defined function for use as a collating function in SQL statements</span></li>
   <li><span class="function"><strong>sqlite_create_function()</strong></span></li>
   <li><span class="function"><strong>sqlite_create_aggregate()</strong></span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>