SQLite3::createFunction

(PHP 5 >= 5.3.0, PHP 7)

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

Описание

public SQLite3::createFunction ( string $name , mixed $callback [, int $argument_count = -1 [, int $flags = 0 ]] ) : bool

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

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

name

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

callback

Имя функции PHP или пользовательской функции, применяемая в качестве обратного вызова, определяющая поведение функции SQL.

Эта функция должна быть определена как:

callback ( mixed $value1 [, mixed $... ] ) : mixed
value1

Первый аргумент, передаваемый функции SQL.

...

Дополнительные аргументы, передаваемые функции SQL.

argument_count

Число аргументов, принимаемых функцией 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"