Enregistre une fonction PHP à utiliser comme fonction d'aggrégation SQLite

Description

public SQLite3::createAggregate(
    string $name,
    callable $stepCallback,
    callable $finalCallback,
    int $argCount = -1
): bool

Enregistre une fonction PHP ou une fonction définie par l'utilisateur à utiliser comme fonction d'agrégation SQL, qui sera utilisée dans les requêtes SQL.

Liste de paramètres

name

Nom de la fonction d'agrégation SQL à créer ou à redéfinir.

stepCallback

Fonction de rappel appelée pour chaque ligne dans le jeu de résultats. Votre fonction PHP devrait accumuler le résultat et stocker son contexte d'agrégation.

Cette fonction doit être définie comme :

step(
    mixed $context,
    int $rownumber,
    mixed $value,
    mixed ...$values
): mixed

context: null pour la première ligne ; sur les lignes suivantes ceci aura la valeur qui a été précedement retourné par la fonction step ; vous devriez utiliser ceci pour maintenir l'état d'aggregation.
rownumber: Le numéro de ligne courante.
value: Le premier argument à passer à l'agrégateur.
values: Arguments supplémentaires à passer à l'agrégateur.

La valeur retournée de cette fonction sera utilisée comme argument context lors du prochain appel d'une fonction d'étape ou finale.

finalCallback

Fonction de rappel pour agréger les "étapes" de données de chaque ligne. Une fois que toutes les lignes ont été traitées, la fonction sera appelée, prendra les données du contexte d'agrégation et retournera le résultat. La fonction de rappel doit retourner un type compris par SQLite (i.e. un type scalaire).

Cette fonction doit être définie comme :

fini(mixed $context, int $rownumber): mixed

context: Contient la valeur de retour du tout dernier appel à la fonction step.
rownumber: Toujours 0.

La valeur de retour de cette fonction sera utilisée comme valeur de retour pour l'agrégation.

argCount

Le nombre d'arguments pris par la fonction d'agrégation SQL. Si ce nombre est négatif, alors la fonction d'agrégation SQL pourra prendre un nombre non défini d'arguments.

Valeurs de retour

Retourne true si la création de l'agrégat a réussie, ou false si une erreur survient.

Exemples

Exemple #1 Exemple d'une fonction d'agrégation avec max_length


<?php
$data = array(
   'one',
   'two',
   'three',
   'four',
   'five',
   'six',
   'seven',
   'eight',
   'nine',
   'ten',
   );
$db = new SQLite3(':memory:');
$db->exec("CREATE TABLE strings(a)");
$insert = $db->prepare('INSERT INTO strings VALUES (?)');
foreach ($data as $str) {
    $insert->bindValue(1, $str);
    $insert->execute();
}
$insert = null;

function max_len_step($context, $rownumber, $string) 
{
    if (strlen($string) > $context) {
        $context = strlen($string);
    }
    return $context;
}

function max_len_finalize($context, $rownumber) 
{
    return $context === null ? 0 : $context;
}

$db->createAggregate('max_len', 'max_len_step', 'max_len_finalize');

var_dump($db->querySingle('SELECT max_len(a) from strings'));
?>

L'exemple ci-dessus va afficher :

int(5)

Dans cet exemple, on crée une fonction agrégative qui va calculer la longueur de la plus grande chaîne de caractères dans une des colonnes de la table. Pour chaque ligne, la fonction max_len_step est appelée et le paramètre $context est passé. Le paramètre de contexte est comme n'importe quelle autre variable PHP et doit être fixé pour contenir un tableau ou même, un objet. Dans cet exemple, nous l'utilisons pour contenir la taille maximale que nous avons vu jusqu'à présent ; si le paramètre $string a une grandeur plus importante que celle courante, on met à jour le contexte pour contenir cette nouvelle taille maximale.

Une fois que toutes les lignes ont été traitées, SQLite appelle la fonction max_len_finalize pour déterminer le résultat agrégatif. Ici, nous pourrions effectuer des calculs basés sur les données trouvées dans $context. Dans notre exemple simple, nous avons calculé le résultat comme si la requête progressait, alors que nous avons simplement besoin de retourner la valeur de contexte.

Astuce

Il n'est PAS recommandé d'enregistrer une copie des valeurs dans le contexte pour finalement les traiter. Dans ce cas, SQLite utiliserait beaucoup trop de mémoire pour traiter la requête - imaginez la quantité de mémoire nécessaire si un million de lignes étaient enregistrées en mémoire, sachant que chaque ligne contient une chaîne de caractères (32 octets par chaîne).

Astuce

Vous pouvez utiliser SQLite3::createAggregate() pour surcharger les fonctions natives de SQLite.