(PHP 5 >= 5.3.0, PHP 7, PHP 8)
SQLite3::createFunction — Registriert eine PHP-Funktion, die als SQL-Skalar-Funktion genutzt werden kann
$name,$callback,$argCount = -1,$flags = 0Registriert eine PHP- oder benutzerdefinierte Funktion, die als SQL-Skalar-Funktion innerhalb einer SQL-Anweisung genutzt werden kann.
nameName der SQL-Funktion, die erstellt oder neu definiert werden soll.
callbackDer Name der PHP- oder benutzerdefinierten Funktion, welche als Callback-Funktion agieren soll und das Verhalten der SQL-Funktion definiert.
Diese Funktion muss wie folgt definiert werden:
valueDas erste Argument, dass an die SQL-Funktion übergeben wurde.
valuesWeitere Argumente, die an die SQL-Funktion übergeben wurden.
argCount
Die Anzahl an Argumenten, die die SQL-Funktion entgegen nimmt. Ist der
Parameter gleich -1, ist die SQL-Funktion nicht auf
eine Parameteranzahl eingeschränkt.
flags
Ein bitweise Oder-Verknüpfung von Flags. Zurzeit wird nur
SQLITE3_DETERMINISTIC unterstützt, das angibt,
dass die Funktion in einer einzelnen SQL-Anweisung immer dasselbe
Ergebnis für dieselben Eingaben liefert.
Gibt true zurück, wenn die Funktion erfolgreich erstellt wurde.
Anderenfalls wird false zurückgegeben.
| Version | Beschreibung |
|---|---|
| 7.1.4 |
Der flags-Parameter wurde hinzugefügt.
|
Beispiel #1 SQLite3::createFunction()-Beispiel
<?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")'));
?>Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:
string(32) "098f6bcd4621d373cade4e832627b4f6"
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)");?>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:<?phpsetlocale(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:<?phpfunction 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).