Pdo\Sqlite::createFunction

(PHP 8 >= 8.4.0)

Pdo\Sqlite::createFunction — Enregistre une fonction utilisateur pour une utilisation dans les instructions SQL

Description

public function Pdo\Sqlite::createFunction(
    string $function_name,
    callable $callback,
    int $num_args = -1,
    int $flags = 0
): bool

Cette méthode permet les fonctions PHP d'être enregistrées avec SQLite en tant que fonction définie par l'utilisateur, de sorte qu'elles puissent être appelées dans les requêtes SQL. La fonction définie peut être utilisée dans n'importe quelle requête SQL qui permet des appels de fonction, par exemple SELECT, UPDATE, ou des déclencheurs.

Astuce

En utilisant cette méthode, il est possible de remplacer les fonctions SQL natives.

Liste de paramètres

function_name

Le nom de la fonction utilisé dans les instructions SQL.

callback

La fonction de rappel pour gérer la fonction SQL définie.

Note: La fonction de rappel doit retourner un type compris par SQLite (c'est-à-dire type scalaire).

Cette fonction doit être définie comme :

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

value: Le premier argument passé à la fonction SQL.
values: Les arguments supplémentaires passés à la fonction SQL.

num_args

Le nombre d'arguments que la fonction SQL prend. Si ce paramètre est -1, alors la fonction SQL peut prendre n'importe quel nombre d'arguments.

flags

Un masque de bits de drapeaux. Actuellement, seul Pdo\Sqlite::DETERMINISTIC est supporté, 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.

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Exemples

Exemple #1 Pdo\Sqlite::createFunction() example

Dans cet exemple, nous avons une fonction qui calcule la somme SHA256 d'une chaîne, puis la renverse. Lorsque l'instruction SQL est exécutée, elle retourne la valeur du nom de fichier transformé par notre fonction. Les données retournées dans $rows contiennent le résultat traité.

La beauté de cette technique est qu'il n'est pas nécessaire de traiter le résultat en utilisant une boucle foreach après l'exécution de la requête.

<?php
function sha256_and_reverse($string)
{
    return strrev(hash('sha256', $string));
}

$db = new Pdo\Sqlite('sqlite::sqlitedb');
$db->createFunction('sha256rev', 'sha256_and_reverse', 1);
$rows = $db->query('SELECT sha256rev(filename) FROM files')->fetchAll();
?>

Voir aussi

Pdo\Sqlite::createAggregate() - Enregistre une fonction utilisateur d'agrégation pour une utilisation dans les instructions SQL
Pdo\Sqlite::createCollation() - Enregistre une fonction utilisateur de tri pour une utilisation dans les instructions SQL
sqlite_create_function()
sqlite_create_aggregate()

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.