SQLite3::createFunction

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

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

Описание

publicSQLite3::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
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"
To Top