createfunction.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 28930349caaaa78f908c380e44066d37a70e97b8 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="pdo-sqlite.createfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Pdo\Sqlite::createFunction</refname>
  <refpurpose>
   Регистрирует определяемую пользователем функцию для использования в SQL-выражениях
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Pdo\\Sqlite">
   <modifier>public</modifier> <type>bool</type><methodname>Pdo\Sqlite::createFunction</methodname>
   <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>num_args</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Метод позволяет зарегистрировать PHP-функцию в SQLite как пользовательскую функцию,
   чтобы её можно было вызывать в SQL-выражениях.
   Определённая функция может быть использована в любом SQL-запросе,
   допускающем вызов функции, например <literal>SELECT</literal>, <literal>UPDATE</literal> или триггерах.
  </simpara>
  <tip>
   <simpara>
    С помощью метода можно переопределить встроенные SQL-функции.
   </simpara>
  </tip>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>function_name</parameter></term>
    <listitem>
     <simpara>
      Имя функции, используемой в SQL-выражениях.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     <simpara>
      Callback-функция для обработки определённой SQL-функции.
     </simpara>
     <note>
      <simpara>
       Callback-функции должны возвращать тип, понятный SQLite
       (например, <link linkend="language.types.intro">скалярный тип</link>).
      </simpara>
     </note>
     <para>
      Сигнатура функции должна быть определена как:
      <methodsynopsis>
       <type>mixed</type><methodname><replaceable>callback</replaceable></methodname>
       <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
       <methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
      </methodsynopsis>
      <variablelist>
       <varlistentry>
        <term><parameter>value</parameter></term>
        <listitem>
         <para>
          Первый аргумент, передаваемый SQL-функции.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>values</parameter></term>
        <listitem>
         <para>
          Дополнительные аргументы, передаваемые SQL-функции.
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_args</parameter></term>
    <listitem>
     <simpara>
      Количество аргументов, которые принимает SQL-функция.
      Если параметр равен <literal>-1</literal>, то SQL-функция
      может принимать любое количество аргументов.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <simpara>
      Битовая маска флагов.
      В настоящее время поддерживается только флаг <constant>Pdo\Sqlite::DETERMINISTIC</constant>,
      который указывает, что функция всегда возвращает один и тот же результат
      при одинаковых входных данных в рамках одного SQL-выражения.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   &return.success;
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="pdo-sqlite.createfunction.example.basic">
   <title>Пример использования метода <methodname>Pdo\Sqlite::createFunction</methodname></title>
   <simpara>
    В этом примере функция вычисляет сумму SHA256 строки, а затем меняет её на противоположную.
    При выполнении SQL-выражения она возвращает значение имени файла,
    преобразованного функцией.
    Данные, возвращаемые в переменную <varname>$rows</varname>,
    содержат обработанный результат.
   </simpara>
   <simpara>
    Прелесть техники в том, что после выполнения запроса
    не нужно обрабатывать результат с помощью цикла &foreach;.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
function sha256_and_reverse($string)
{
    return strrev(hash('sha256', $string));
}

$db = new Pdo\Sqlite('sqlite::sqlitedb');
$db->createFunction('sha256rev', 'sha256_and_reverse', 1);
$rows = $db->query('SELECT sha256rev(filename) FROM files')->fetchAll();
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Pdo\Sqlite::createAggregate</methodname></member>
   <member><methodname>Pdo\Sqlite::createCollation</methodname></member>
   <member><function>sqlite_create_function</function></member>
   <member><function>sqlite_create_aggregate</function></member>
  </simplelist>
 </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
-->