sqlite_create_function

PHP マニュアル
前のページ		次のページ

説明

void sqlite_create_function ( resource dbhandle, string function_name, callback callback [, int num_args] )

オブジェクト指向言語型スタイル (メソッド):

class SQLiteDatabase {

void createFunction ( string function_name, callback callback [, int num_args] )

}

sqlite_create_function() により、SQLiteにPHP関数をUDF (ユーザ定義関数)として登録することが可能です。この関数は、SQLステートメントの中からコールできます。

UDFは、SELECTおよびUPDATEステートメント、そして、トリガーの中のように関数をコールできる全てのSQLステートメントで使用可能です。

パラメータ

dbhandle: SQLite データベースリソース。手続きに従って、 sqlite_open() から返されます。このパラメータは、オブジェクト指向言語型メソッドを使用する場合は不要です。
function_name: SQL ステートメントで使用する関数名
callback: 定義された SQL 関数を処理するためのコールバック関数
注意: コールバック関数は SQLite で有効な型 (例えばスカラー型) を返す必要があります
num_args: コールバック関数が規定の引数の数を受け入れるかどうかを決定するため SQLite パーサに渡すヒント

注意: (MySQL のような)他のデータベースエクステンションとの互換性のため、 2 種類の構文がサポートされています。推奨されるのは最初の構文で、dbhandle パラメータを関数の最初のパラメータとするものです。

返り値

値を返しません。

例

例 1. sqlite_create_function() の例


<?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 'Error opening sqlite db: ' . $sqliteerror;
    exit;
}
?>

この例では、文字列のMD5サムを計算し、順番を反転する関数が記述されています。このSQLステートメントが実行された場合、関数により変換されたファイル名の値を返します。 $rows により返されるデータには、処理結果が含まれています。

この技術の美しいところは、データのクエリーを実行した後で foreach() ループにより結果を処理する必要がないことです。

PHP は、データベースが最初にオープンされる際に php という名前の特別な関数を登録します。このphp関数は、事前に登録することなしにあらゆるPHP関数をコールするために使用可能です。

例 2. PHP 関数の使用例


<?php
$rows = sqlite_array_query($dbhandle, "SELECT php('md5', filename) from files");
?>

この例は、データベースの各 filename カラムについて md5() をコールし、その結果を $rowsに返します。

注意: 性能上の理由から、PHPはUDFとの間で送受信されるバイナリデータを自動的にエンコード/デコードしません。この方法でバイナリデータを処理する必要がある場合、パラメータを手動でエンコード/デコードし、値を返すようにする必要があります。詳細については、sqlite_udf_encode_binary() およびsqlite_udf_decode_binary()を参照して下さい。

ティップ: 適用するアプリケーションの主要な要求が高い性能でない限り、バイナリデータの処理を行うためにUDFを使用することは推奨されません。

ティップ: SQLiteのネーティブSQL関数をオーバーライドするために sqlite_create_function()および sqlite_create_aggregate()も使用可能です。

前のページ	ホーム	次のページ
sqlite_create_aggregate	上に戻る	sqlite_current

sqlite_create_function

説明

パラメータ

返り値

例

参考