(PHP 5 < 5.4.0, sqlite >= 1.0.0)
sqlite_create_function -- SQLiteDatabase::createFunction — Enregistre une fonction utilisateur "classique" UDF pour SQLite
$dbhandle
, string $function_name
, callable $callback
[, int $num_args = -1
] )Style orienté objet (méthode) :
$function_name
, callable $callback
[, int $num_args = -1
] )sqlite_create_function() vous permet d'enregistrer une fonction PHP dans SQLite comme UDF (Fonction Définie par l'Utilisateur, User Defined Function), pour qu'elle soit accessible depuis les requêtes SQL.
Les UDF peuvent être utilisées dans n'importe quelle requête SQL qui peut appeler des fonctions, telles que SELECT et UPDATE, ou même des déclencheurs.
dbhandle
La ressource de base de données SQLite; retournée par sqlite_open() lorsqu'utilisée de manière procédurale. Ce paramètre n'est pas requis si vous utilisez la méthode orientée objet.
function_name
Le nom de la fonction utilisée dans les requêtes SQL.
callback
Fonction de procédure de rappel pour gérer les fonctions SQL définies.
Note: Les fonctions de procédure de rappel devraient retourner un type compris par SQLite (c'est-à-dire, voir type scalaire).
num_args
Conseil à l'analyseur SQLite si la fonction de procédure de rappel accepte un nombre prédéterminé d'arguments.
Note: Deux syntaxes alternatives sont supportées pour assurer la compatibilité avec les autres bases de données (telles que MySQL) : la forme recommandée est la première, où le paramètre
dbhandleest le premier dans la fonction.
Aucune valeur n'est retournée.
Exemple #1 Exemple avec sqlite_create_function()
<?php
function md5_and_reverse($string)
{
return strrev(md5($string));
}
if ($dbhandle = sqlite_open('mysqlitedb', 0666, $sqliteerror)) {
sqlite_create_function($dbhandle, 'md5rev', 'md5_and_reverse', 1);
$sql = 'SELECT md5rev(filename) FROM files';
$rows = sqlite_array_query($dbhandle, $sql);
} else {
echo 'Erreur pendant l\'ouverture de la base db : ' . $sqliteerror;
exit;
}
?>
Dans cet exemple, nous avons une fonction qui calcule la somme de contrôle
MD5 d'une chaîne, et l'inverse. Lorsque la requête SQL s'exécute,
elle retourne le nom du fichier, transformé par cette opération.
Les données retournées dans $rows contiennent le
résultat.
La beauté de cette technique est que vous n'avez pas à traiter vous-même les données avec une boucle, une fois que vous avez lu les données.
PHP enregistre une fonction spéciale appelée PHP lorsque la base est ouverte. Cette fonction est utilisée pour appeler toute fonction PHP sans avoir à l'enregistrer au préalable.
Exemple #2 Exemple d'utilisation d'une fonction PHP dans SQLite
<?php
$rows = sqlite_array_query($db, "SELECT php('md5', filename) from files");
?>
Cet exemple va appeler la fonction md5() sur chaque
colonne filename dans la base, et retourner le contenu
dans le tableau $rows.
Note:
Pour des raisons de performances, PHP ne va pas automatiquement coder ou décoder les données binaires passées à votre UDF. Vous devez le faire manuellement. Voyez les fonctions sqlite_udf_encode_binary() et sqlite_udf_decode_binary() pour plus de détails.
Il n'est pas recommandé d'utiliser des UDF pour traiter des données binaires, à moins que les performances ne soient pas un problème pour votre application.
Vous pouvez utiliser sqlite_create_function() et sqlite_create_aggregate() pour remplacer des fonctions natives SQLite.