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

<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>SQL のスカラー関数として使用する PHP 関数を登録する</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>

SQL のスカラー関数として使用する PHP 関数を登録します。

これは 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 の関数あるいはユーザー定義関数の名前。

これが 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">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

</refsect1>

</refentry>