PDO::sqliteCreateFunction

(no version information, might be only in CVS)

PDO::sqliteCreateFunction --  Registers a User Defined Function for use in SQL statements

説明

bool PDO::sqliteCreateFunction ( string function_name, callback callback [, int num_args] )

警告

この関数は、 実験的 なものです。この関数の動作・ 名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP のリリースにおいて変更される可能性があります。 この関数は自己責任で使用してください。

PDO::sqliteCreateFunction() allows you to register a PHP function with SQLite as an UDF (User Defined Function), so that it can be called from within your SQL statements.

The UDF can be used in any SQL statement that can call functions, such as SELECT and UPDATE statements and also in triggers.

パラメータ

function_name

The name of the function used in SQL statements.

callback

Callback function to handle the defined SQL function.

注意: Callback functions should return a type understood by SQLite (i.e. scalar type).

num_args

Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.

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

例 1. PDO::sqliteCreateFunction() example

<?php
function md5_and_reverse($string)
{
    return
strrev(md5($string));
}

$db = new PDO('sqlite:sqlitedb');
$db->sqliteCreateFunction('md5rev', 'md5_and_reverse', 1);
$rows = $db->query('SELECT md5rev(filename) FROM files')->fetchAll();
?>

In this example, we have a function that calculates the md5 sum of a string, and then reverses it. When the SQL statement executes, it returns the value of the filename transformed by our function. The data returned in $rows contains the processed result.

The beauty of this technique is that you do not need to process the result using a foreach() loop after you have queried for the data.

ティップ: You can use PDO::sqliteCreateFunction() and PDO::sqliteCreateAggregate() to override SQLite native SQL functions.

注意: This method is not available with the SQLite2 driver. Use the old style sqlite API for that instead.

参考

PDO::sqliteCreateAggregate()
sqlite_create_function()
sqlite_create_aggregate()