<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: f27cfeeefc13717f86a53d7fefa0ce54f7bfaaaf Maintainer: lex Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="sqlite3.createfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>SQLite3::createFunction</refname>

<refpurpose>Регистрирует функцию PHP для использования в качестве скалярной функции SQL</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="SQLite3">

<modifier>public</modifier> <type>bool</type><methodname>SQLite3::createFunction</methodname>

<methodparam><type>string</type><parameter>name</parameter></methodparam>

<methodparam><type>callable</type><parameter>callback</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>argCount</parameter><initializer>-1</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Регистрирует функцию PHP или пользовательскую функцию для использования

в качестве скалярной функции SQL для использования в SQL-выражениях.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>name</parameter></term>

<listitem>

<para>

Имя создаваемой или переопределяемой функции SQL.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<para>

Имя функции PHP или пользовательской функции,

применяемой в качестве callback, определяющей поведение функции SQL.

</para>

<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>argCount</parameter></term>

<listitem>

<para>

Число аргументов, принимаемых функцией SQL. Если этот параметр равен <literal>-1</literal>,

то функция SQL может принимать любое количество аргументов.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

Побитовое объединение флагов.

В настоящее время поддерживается только <constant>SQLITE3_DETERMINISTIC</constant>,

который указывает, что функция всегда возвращает один и тот же результат,

учитывая одни и те же входные данные внутри одного SQL-выражения.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Возвращает &true; в случае успешного создания функции или &false; в случае возникновения ошибки.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>7.1.4</entry>

<entry>

Добавлен параметр <parameter>flags</parameter>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Пример использования <function>SQLite3::createFunction</function></title>

<programlisting role="php">

<![CDATA[

<?php

function my_udf_md5($string)

{

return hash('md5', $string);

}

$db = new SQLite3('mysqlitedb.db');

$db->createFunction('my_udf_md5', 'my_udf_md5');

var_dump($db->querySingle('SELECT my_udf_md5("test")'));

?>

]]>

</programlisting>

&example.outputs.similar;

<screen>

<![CDATA[

string(32) "098f6bcd4621d373cade4e832627b4f6"

]]>

</screen>

</example>

</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

-->