SQLite3::createFunction

    (PHP 5 >= 5.3.0, PHP 7, PHP 8)

    SQLite3::createFunction — SQL のスカラー関数として使用する PHP 関数を登録する

    説明

    public SQLite3::createFunction(
        string $name,
        callable $callback,
        int $argCount = -1,
        int $flags = 0
    ): bool

    SQL のスカラー関数として使用する PHP 関数を登録します。 これは SQL 文の中で使用されるものです。

    パラメータ

    name

    作成あるいは再定義したい SQL 関数の名前。

    callback

    コールバックとして指定する、 PHP の関数あるいはユーザー定義関数の名前。 これが SQL 関数の振る舞いを定義します。

    この関数は、以下のように定義されるべきです:

    callback(mixed $value, mixed ...$values): mixed
    value

    SQL 関数に渡される最初の引数

    values

    SQL 関数に渡されるふたつめ以降の引数

    argCount

    SQL 関数が受け取るパラメータの数。 -1 を指定すると、SQL 関数は任意の数の引数を受け取るようになります。

    flags

    フラグのビット単位の組み合わせ。 現状では、 SQLITE3_DETERMINISTIC だけがサポートされています。 これは、単一のSQLの範囲の中では、同じ入力を与えると常に同じ結果が返るということを指定します。

    戻り値

    関数の作成に成功した場合に true、失敗した場合に false を返します。

    変更履歴

    バージョン 説明
    7.1.4 flags パラメータが追加されました。

    例

    例1 SQLite3::createFunction() の例

    <?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")'));
    ?>

    上の例の出力は、 たとえば以下のようになります。

    string(32) "098f6bcd4621d373cade4e832627b4f6"

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    9
    koalay at gmail dot com
    14 years ago
    Since regular expression is not supported by default SQLite, we can create a user function to do the job.

    <?php

    $db     = new SQLite3("database.sqlit3", 0666);

    // create a function named "preg_match"
    // with the php core function "preg_match"
    if ($db->createFunction("preg_match", "preg_match", 2) === FALSE)
    exit(    "Failed creating function\n");

    // this query will then works as expected
    $result = $db->query("SELECT * FROM table1 WHERE
    preg_match('/^(apple|orange)$/', variable1)"    );

    ?>
    up
    -1
    bohwaz
    12 years ago
    In PHP 5.4 there will be a createCollation method to use your custom collation method, to be able to sort datasets using unicode, like this:

    <?php
    setlocale    (LC_COLLATE, 'fr_FR.UTF-8');
    $db->createCollation('PHP_COLLATE', 'strcoll');

    $db->query('SELECT * FROM my_table ORDER BY name COLLATE PHP_COLLATE;');
    ?>

    But until this cool feature becomes available, you'll have to do some tricks, like this for french:

    <?php
    function sqlite3_to_ascii($str, $charset = 'UTF-8')
    {
    // Don't process empty strings
    if (!trim($str))
    return     $str;

    // We only process non-ascii strings
    if (preg_match('!^[[:ascii:]]+$!', $str))
    return     $str;

    $str = htmlentities($str, ENT_NOQUOTES, $charset);

    $str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str);
    $str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str);
    $str = preg_replace('#&[^;]+;#', '', $str);

    return     $str;
    }

    $db->createFunction('to_ascii', 'sqlite3_to_ascii', 1);
    $res = $db->query('SELECT * FROM test ORDER BY to_ascii(text);');
    ?>

    This will convert non-ascii characters to ascii ones before collation. In fact this won't work with non-latin languages, but for latin-languages it's better than nothing.

    Please note that this will slow down about 1.8 times the query (tested on a 10.000 rows table).
    ＋add a note
    To Top