Files
doc-fr/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml
Yannick Torres 422a55233c sync with EN
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@275718 c90b9560-bf6c-de11-be94-00142212c4b1
2009-02-12 23:17:30 +00:00

261 lines
8.5 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<!-- EN-Revision: 1.12 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pdo-sqlitecreateaggregate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PDO::sqliteCreateAggregate</refname>
<refpurpose>
Référence une fonction définie par l'utilisateur agrégative pour une utilisation dans les requêtes SQL
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>PDO</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>sqliteCreateAggregate</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>callback</type><parameter>step_func</parameter></methodparam>
<methodparam><type>callback</type><parameter>finalize_func</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>num_args</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
&warn.experimental.func;
<para>
Cette méthode est similaire à <xref linkend="function.pdo-sqlitecreatefunction"
/> à l'exception qu'elle référence les fonctions qui peuvent être utilisées pour calculer un
résultat agrégé à travers toutes les lignes d'une requête.
</para>
<para>
La différence entre cette méthode et <xref
linkend="function.pdo-sqlitecreatefunction" /> est que deux fonctions sont
requises pour gérer les agrégation.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
Le nom de la fonction utilisée dans les requêtes SQL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>step_func</parameter></term>
<listitem>
<para>
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.
</para>
<para>
Cette fonction doit être définie comme :
<methodsynopsis>
<methodname><replaceable>step</replaceable></methodname>
<methodparam><type>mixed</type><parameter>context</parameter></methodparam>
<methodparam><type>int</type><parameter>rownumber</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>value2</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>..</parameter></methodparam>
</methodsynopsis>
</para>
<para>
<varname>context</varname> vaudra &null; pour la première ligne; pour les lignes suivantes,
il vaudra la même valeur que celle précédemment retournée par la fonction step; vous devriez
l'utiliser pour maintenir l'état d'agrégation.
</para>
<para>
<varname>rownumber</varname> contiendra le nombre de lignes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>finalize_func</parameter></term>
<listitem>
<para>
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 retournera une type compris
par SQLite (c'est-à-dire <link
linkend="language.types.intro">un type scalaire</link>).
</para>
<para>
Cette fonction doit être définie comme :
<methodsynopsis>
<methodname><replaceable>fini</replaceable></methodname>
<methodparam><type>mixed</type><parameter>context</parameter></methodparam>
<methodparam><type>int</type><parameter>rownumber</parameter></methodparam>
</methodsynopsis>
</para>
<para>
<varname>context</varname> contiendra la valeur de retour du tout dernier appel à
la fonction step.
</para>
<para>
<varname>rownumber</varname> contiendra le nombre de lignes sur lesquelles l'agrégation a
eu lieu.
</para>
<para>
La valeur de retour de cette fonction sera utilisée comme valeur de retour pour
l'agrégation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num_args</parameter></term>
<listitem>
<para>
Conseil à l'analyseur SQLite si la fonction de rappel accepte un nombre
prédéterminé d'arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple d'agrégation avec une fonction max_length</title>
<programlisting role="php">
<![CDATA[
<?php
$data = array(
'un',
'deux',
'trois',
'quatre',
'cinq',
'six',
'sept',
'huit',
'neuf',
'dix',
);
$db = new PDO('sqlite::memory:');
$db->exec("CREATE TABLE strings(a)");
$insert = $db->prepare('INSERT INTO strings VALUES (?)');
foreach ($data as $str) {
$insert->execute(array($str));
}
$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;
}
$db->sqliteCreateAggregate('max_len', 'max_len_step', 'max_len_finalize');
var_dump($db->query('SELECT max_len(a) from strings')->fetchAll());
?>
]]>
</programlisting>
</example>
</para>
<para>
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 <literal>max_len_step</literal> est
appelée et le paramètre <parameter>context</parameter> 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 <parameter>string</parameter> a une grandeur plus
importante que celle courante, on met à jour le contexte pour contenir cette
nouvelle taille maximale.
</para>
<para>
Une fois que toutes les lignes ont été traitées, SQLite appelle la fonction
<literal>max_len_finalize</literal> pour déterminer le résultat agrégatif.
Ici, nous pourrions effectuer des calculs basés sur les données trouvées
dans <parameter>context</parameter>. 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.
</para>
<tip>
<para>
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).
</para>
</tip>
<tip>
<para>
Vous pouvez utiliser <xref linkend="function.pdo-sqlitecreatefunction" /> et
<xref linkend="function.pdo-sqlitecreateaggregate" /> pour surcharger les
fonctions natives de SQLite.
</para>
</tip>
<note>
<para>
Cette méthode n'est pas disponible avec les pilotes de SQLite2.
Utilisez l'ancien style de l'API sqlite à la place.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.pdo-sqlitecreatefunction" /></member>
<member><function>sqlite_create_function</function></member>
<member><function>sqlite_create_aggregate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->