SQLite3::createFunction

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

    SQLite3::createFunction — Регистрирует функцию PHP для использования в качестве скалярной функции SQL

    Описание

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

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

    Список параметров

    name

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

    callback

    Имя функции PHP или пользовательской функции, применяемой в качестве callback, определяющей поведение функции 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"

    Улучшение страницы

    Инструкция • Исправление • Сообщение об ошибке
    ＋Добавить

    Примечания пользователей 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).
    ＋Добавить
    To Top