(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo_sqlite >= 1.0.0)
PDO::sqliteCreateFunction — Référence une fonction définie par l'utilisateur pour une utilisation dans les requêtes SQL
$function_name
,$callback
,$num_args
= -1,$flags
= 0Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la documentation autour de cette fonction peut changer sans préavis dans une prochaine version de PHP. Cette fonction doit être utilisée à vos risques et périls.
Cette méthode vous permet de référencer
une fonction PHP avec SQLite comme étant un UDF
(User Defined Function
), de telle façon qu'elle
puisse être appelée à l'intérieur de vos requêtes SQL.
Un UDF peut être utilisé dans n'importe quelle requête SQL qui peut appeler des fonctions, par exemple les requêtes SELECT et UPDATE mais aussi dans les marqueurs.
function_name
Le nom de la fonction utilisé dans les requêtes SQL.
callback
Fonction de rappel pour manipuler la fonction SQL définie.
Note: Les fonctions de rappel devraient retourner un type connu par SQLite (c'est-à-dire type scalaire).
Cette fonction doit être définit comme :
value
Le premier argument à passer à la fonction SQL.
values
Arguments supplémentaires à passer à la fonction SQL.
num_args
Nombre d'arguments que la fonction SQL prend. Si ce paramètre est
-1
, la fonction SQL peut prendre n'importe quel nombre
d'arguments.
flags
Une conjonction d'opérations de bits d'indicateurs. Actuellement, seul
PDO::SQLITE_DETERMINISTIC
est pris en charge, ce qui
spécifie que la fonction retourne toujours le même résultat étant donné
les mêmes entrées dans une seule instruction SQL.
Version | Description |
---|---|
7.1.4 |
Le paramètre flags a été ajouté.
|
Exemple #1 Exemple avec PDO::sqliteCreateFunction()
<?php
function md5_and_reverse($string)
{
return strrev(hash('md5', $string));
}
$db = new PDO('sqlite:sqlitedb');
$db->sqliteCreateFunction('md5rev', 'md5_and_reverse', 1);
$rows = $db->query('SELECT md5rev(filename) FROM files')->fetchAll();
?>
Dans cet exemple, nous avons une fonction qui calcule la somme MD5 de la
chaîne de caractères et la renverse ensuite. Lorsque la requête SQL
s'exécute, elle retourne la valeur du nom du fichier transformée par notre
fonction. Les données retournées dans $rows
contiennent le résultat traité.
La beauté de cette technique est que vous n'avez pas à traiter le résultat en utilisant une boucle foreach après que vous ayez récupéré les données.
Vous pouvez utiliser PDO::sqliteCreateFunction et PDO::sqliteCreateAggregate pour surcharger les fonctions natives de SQL.