SQLite3::createFunction

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

SQLite3::createFunctionRegistra una función PHP para su uso como función escalar SQL

Descripción

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

Registra una función PHP o una función de usuario para su uso como función escalar SQL, para su utilización en las consultas SQL.

Parámetros

name

Nombre de la función SQL a crear o redefinir.

callback

El nombre de la función PHP o la función de usuario a aplicar como callback, definiendo el comportamiento de la función SQL.

Esta función debe ser definida como:

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

El primer argumento a pasar a la función SQL.

values

Argumentos adicionales a pasar a la función SQL.

argCount

Número de argumentos que la función SQL acepta. Si este parámetro es -1, la función SQL puede aceptar cualquier número de argumentos.

flags

Una conjunción de operaciones a nivel de bits de indicadores. Actualmente, solo SQLITE3_DETERMINISTIC es soportado, lo cual especifica que la función devuelve siempre el mismo resultado dado los mismos argumentos en una sola instrucción SQL.

Valores devueltos

Devuelve true si la función fue creada con éxito, false si ocurre un error.

Historial de cambios

Versión Descripción
7.1.4 El parámetro flags fue añadido.

Ejemplos

Ejemplo #1 Ejemplo con 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")'));
?>

El resultado del ejemplo sería algo similar a:

string(32) "098f6bcd4621d373cade4e832627b4f6"