cvs: peardoc /fr/package/database/db/db-common freeprepared.xml getall.xml getassoc.xml getcol.xml
| From: | Yannick TORRES | Date: | Wed, 07 Jul 2004 10:21:22 +0000 |
| Subject: | cvs: peardoc /fr/package/database/db/db-common freeprepared.xml getall.xml getassoc.xml getcol.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-4572@lists.php.net to get a copy of this message | ||
yannick Wed Jul 7 06:21:22 2004 EDT
Modified files:
/peardoc/fr/package/database/db/db-common freeprepared.xml
getall.xml getassoc.xml
getcol.xml
Log:
sync with EN revision
http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/freeprepared.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/fr/package/database/db/db-common/freeprepared.xml diff -u peardoc/fr/package/database/db/db-common/freeprepared.xml:1.1 peardoc/fr/package/database/db/db-common/freeprepared.xml:1.2 --- peardoc/fr/package/database/db/db-common/freeprepared.xml:1.1 Sat Feb 21 21:04:07 2004 +++ peardoc/fr/package/database/db/db-common/freeprepared.xml Wed Jul 7 06:21:21 2004 @@ -1,79 +1,95 @@ -<!-- $Revision: 1.1 $ --> -<!-- EN-Revision: 1.2 Maintainer: didou Status: ready --> -<refentry id="package.database.db.db-common.freeprepared"> - - <refnamediv> - <refname>DB_common::freePrepared()</refname> - <refpurpose>Libère les ressources associées à une requête SQL préparée</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>freePrepared</function></funcdef> - <paramdef>resource <parameter>$stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="package.database.db.db-common.freeprepared.desc"> - &title.desc; - <para> - Détruit la mémoire occupée par la notation interne qui surveille les - requêtes SQL préparées. - Cette fonction <emphasis>n'efface pas</emphasis> l'objet &class.db-result; - lui-même. - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.resource; - <parameter>$stmt</parameter> - </term> - <listitem> - <para> - identifiant de ressource retourné par <function>prepare</function> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.return"> - &title.returns; - <para> - <itemizedlist> - <listitem> - <para> - <parameter>boolean</parameter> - &return.success; - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.note"> - &title.note; - ¬e.notstatic; - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-result.free"> - <function>free</function></link> - </para> - </refsect1> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.2 $ --> +<!-- EN-Revision: 1.10 Maintainer: didou Status: ready --> - </refentry> +<refentry id="package.database.db.db-common.freeprepared"> + <refnamediv> + <refname>DB_common::freePrepared()</refname> + <refpurpose>Libère les ressources associées à une requête SQL préparée</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>boolean <function>freePrepared</function></funcdef> + <paramdef> + resource <parameter>$stmt</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.freeprepared.desc"> + &title.desc; + <para> + Détruit la mémoire occupée par la notation + interne qui surveille les requêtes SQL préparées. + Cette fonction <emphasis>n'efface pas</emphasis> l'objet &class.db-result; + lui-même. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.resource; + <parameter>$stmt</parameter> + </term> + <listitem> + <para> + identifiant de ressource retourné + par <function>prepare</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.return"> + &title.returns; + <para> + &type.bool; - &return.success; + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.example"> + &title.example; + <example> + <title>Exemple avec <function>freePrepared</function></title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$sth = $db->prepare('INSERT INTO numbers (number) VALUES (?)'); +$db->execute($sth, 1); +$db->freePrepared($sth); +?> +]]> + </programlisting> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link>, + <link linkend="package.database.db.db-common.autoprepare"> + <function>autoPrepare</function></link>, + <link linkend="package.database.db.db-result.free"> + <function>free</function></link> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getall.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getall.xml diff -u peardoc/fr/package/database/db/db-common/getall.xml:1.3 peardoc/fr/package/database/db/db-common/getall.xml:1.4 --- peardoc/fr/package/database/db/db-common/getall.xml:1.3 Fri Feb 20 11:30:19 2004 +++ peardoc/fr/package/database/db/db-common/getall.xml Wed Jul 7 06:21:21 2004 @@ -1,202 +1,559 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.14 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.33 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getall"> - <refnamediv> - <refname>DB_common::getAll()</refname> - <refpurpose>Récupère toutes les lignes</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getAll</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - <paramdef> - integer <parameter><optional>$fetchmode = + <refnamediv> + <refname>DB_common::getAll()</refname> + <refpurpose>Récupère toutes les lignes</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getAll</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + array <parameter><optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + integer <parameter><optional>$fetchmode = <constant>DB_FETCHMODE_DEFAULT</constant></optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getall.desc"> - &title.desc; - <para> - Récupère le résultat entier d'une requête dans un tableau imbriqué. - La fonction prend soin d'exécuter la requête et de libérer le résultat - à la fin. - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - La requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau à utiliser dans l'exécution de la requête. - Le nombre d'éléments du tableau doit correspondre au nombre - de marqueurs dans la requête. Cette fonction ne supporte PAS - les scalaires. - </para> - <para> - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.int; - <parameter>$fetchmode</parameter> - </term> - <listitem> - <para> - le mode de récupération à utiliser, - par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.return"> - &title.returns; - <para> - <itemizedlist> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getall.desc"> + &title.desc; + <para> + Récupère le résultat entier d'une requête + dans un tableau imbriqué. + La fonction prend soin d'exécuter la requête et de + libérer le résultat à la fin. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> <listitem> <para> - <parameter>array</parameter> - un tableau imbriqué, ou - &class.db-error; en cas d'erreurs + La requête SQL à préparer </para> </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getall.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getcol"> - <function>getCol</function></link>, - <link linkend="package.database.db.db-common.getall"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getassoc"> - <function>getAssoc</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link> - </para> - </refsect1> - </refentry> + </varlistentry> + <varlistentry> + <term> + &type.array; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau à utiliser dans l'exécution de la requête. + Le nombre d'éléments du tableau doit correspondre au nombre + de marqueurs dans la requête. + </para> + <para> + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + <warning> + <para> + Cette méthode n'autorise pas les scalaires en tant qu'argument. + </para> + </warning> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.int; + <parameter>$fetchmode</parameter> + </term> + <listitem> + <para> + le mode de récupération à utiliser. + Par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant>, + qui demande à la méthode d'utiliser le mode de récupération courant + de DB. Le mode de récupération courant peut être changé + en utilisant + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>. + Les valeurs possibles sont : + <itemizedlist> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_OBJECT</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> | + <constant>DB_FETCHMODE_FLIPPED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> | + <constant>DB_FETCHMODE_FLIPPED</constant> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.return"> + &title.returns; + <para> + &type.array; - un tableau imbriqué ou + un objet &class.db-error; en cas d'erreurs + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="www.php.net/manual/">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.example"> + &title.example; + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif en définissant le mode de récupération par défaut + en premier + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$db->setFetchMode(DB_FETCHMODE_ASSOC); +$data =& $db->getAll('SELECT cf, nf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner + un tableau ordonné + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [0] => Juan + [1] => 5 + [2] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [0] => Kyu + [1] => 10 + [2] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau ordonné et inversé + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ORDERED | DB_FETCHMODE_FLIPPED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [0] => Juan + [1] => Kyu + ) + [1] => Array + ( + [0] => 5 + [1] => 10 + ) + [2] => Array + ( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif inversé + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ASSOC | DB_FETCHMODE_FLIPPED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [cf] => Array + ( + [0] => Juan + [1] => Kyu + ) + [nf] => Array + ( + [0] => 5 + [1] => 10 + ) + [df] => Array + ( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau d'objets + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> dans un mode prepare/execute + pour retourner un tableau associatif + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo WHERE nf = ?', + array(5), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) +) +]]> + </screen> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>, + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getcol"> + <function>getCol</function></link>, + <link linkend="package.database.db.db-common.getassoc"> + <function>getAssoc</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getassoc.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getassoc.xml diff -u peardoc/fr/package/database/db/db-common/getassoc.xml:1.3 peardoc/fr/package/database/db/db-common/getassoc.xml:1.4 --- peardoc/fr/package/database/db/db-common/getassoc.xml:1.3 Fri Mar 5 12:57:12 2004 +++ peardoc/fr/package/database/db/db-common/getassoc.xml Wed Jul 7 06:21:21 2004 @@ -1,252 +1,1027 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.16 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.35 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getassoc"> - <refnamediv> - <refname>DB_common::getAssoc()</refname> - <refpurpose>Récupère le résultat dans un tableau associatif</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getAssoc</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - boolean <parameter> - <optional>$force_array = &false;</optional></parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - <paramdef>integer - <parameter><optional>$fetchmode = - <constant>DB_FETCHMODE_DEFAULT</constant> - </optional></parameter> - </paramdef> - <paramdef> boolean - <parameter><optional>$group = &false;</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getassoc.desc"> - &title.desc; + <refnamediv> + <refname>DB_common::getAssoc()</refname> + <refpurpose>Récupère le résultat dans un tableau </refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getAssoc</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + boolean <parameter><optional>$force_array = &false;</optional></parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + integer <parameter><optional>$fetchmode = + <constant>DB_FETCHMODE_DEFAULT</constant></optional></parameter> + </paramdef> + <paramdef> + boolean <parameter><optional>$group = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getassoc.desc"> + &title.desc; + <para> + Exécute la requête et met la totalité du résultat + dans un tableau associatif et libère le résultat. + </para> + <para> + Si le résultat contient plus de deux colonnes, les valeurs seront + un tableau des valeurs allant des colonnes 2 à n. Si le résultat ne + contient que deux colonnes, la valeur retournée est un scalaire + avec la valeur de la seconde colonne (sauf si vous forcez l'obtention + d'un tableau avec la paramètre <parameter>$force_array</parameter>). + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> + <listitem> + <para> + la requête SQL à préparer + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.bool; + <parameter>$force_array</parameter> + </term> + <listitem> + <para> + utilisé seulement si la requête retourne exactement deux colonnes. + Si &true;, les valeurs du tableau retourné seront des tableaux à + un élément au lieu de scalaires. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau, chaîne ou données numériques à + ajouter à la requête préparée. + Le nombre d'éléments passés doit correspondre + à celui des marqueurs dans la requête + préparée : un marqueur pour les scalaires ou un + marqueur par élément du tableau pour un tableau. + </para> + <para> + Si ce paramètre est fourni, + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.int; + <parameter>$fetchmode</parameter> + </term> + <listitem> + <para> + le mode de récupération à utiliser. + Par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant>, + qui demande à la méthode d'utiliser le mode de récupération + courant de DB. + Le mode de récupération courant de DB peut être modifier + en utilisant + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>. + Les valeurs possibles sont : + <itemizedlist> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_OBJECT</constant> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.bool; + <parameter>$group</parameter> + </term> + <listitem> + <para> + si &true;, les valeurs du tableau retournées sont enveloppés + dans un autre tableau. + Si la même valeur de clef (dans la première colonne) + se répète, les valeurs seront ajoutées à la fin de + ce tableau, au lieu d'écraser les valeurs existantes. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.return"> + &title.returns; + <para> + &type.array; - tableau associatif avec les résultats de + la requête ou un objet &class.db-error; en cas d'erreur. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_TRUNCATED</constant></entry> + <entry> + truncated + </entry> + <entry> + Le résultat contient moins de deux colonnes + </entry> + <entry> + Vérifiez la requête SQL ou choisissez une autre fonction + <function>get*</function> + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="www.php.net/manual/">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.example"> + &title.example; + <para> + Tous les exemples utilisent les données suivantes : + <programlisting role="sql"> +<![CDATA[ +INSERT INTO foo VALUES ('Juan', 5, '1991-01-11 21:31:41'); +INSERT INTO foo VALUES ('Kyu', 10, '1992-02-12 22:32:42'); +INSERT INTO foo VALUES ('Kyu', 15, '1993-03-13 23:33:43'); +]]> + </programlisting> + </para> + + <refsect2 id="package.database.db.db-common.getassoc.example.two"> + <title>Le résultat a deux colonnes</title> <para> - Récupère le résultat dans un tableau associatif en utilisant - la première colonne en tant que clef. La fonction prend soin d'exécuter - la requête et de libérer les résultats à la fin de son exécution. - - Si le résultat contient plus de deux colonnes, les valeurs seront - un tableau des valeurs allant des colonnes 2 à n. Si le résultat ne - contient que deux colonnes, la valeur retournée est un scalaire - avec la valeur de la seconde colonne (sauf si vous forcez l'obtention - d'un tableau avec la paramètre $force_array). + Lorsque vous utilisez <function>getAssoc</function> pour récupérer le résultat + qui a deux colonnes et + <parameter>$force_array</parameter> = &false; (par défaut), + changer <parameter>$fetchmode</parameter> n'aura aucun effet sur le format + du tableau résultant. </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - la requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.bool; - <parameter>$force_array</parameter> - </term> - <listitem> - <para> - utilisé seulement si la requête retourne exactement deux colonnes. - Si &true;, les valeurs du tableau retourné seront des tableaux à un élément - au lieu de scalaires. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau, chaîne ou données numériques à - ajouter à la requête préparée. - Le nombre d'éléments passés doit correspondre - à celui des marqueurs dans la requête - préparée : un marqueur pour les scalaires ou un - marqueur par élément du tableau pour un tableau. - </para> - <para> - Si ce paramètre est fourni, - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.int; - <parameter>$fetchmode</parameter> - </term> - <listitem> - <para> - le mode de récupération à utiliser - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.bool; - <parameter>boolean $group</parameter> - </term> - <listitem> - <para> - si &true;, les valeurs du tableau retournées sont enveloppés dans un - autre tableau. - Si la même valeur de clef (dans la première colonne) - se répète, les valeurs seront ajoutées à la fin de ce tableau, au lieu - d'écraser les valeurs existantes. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.return"> - &title.returns; - <para> - <parameter>array</parameter> - tableau associatif avec les résultats de - la requête. - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_TRUNCATED</constant></entry> - <entry> - &null; - </entry> - <entry> - Le résultat contient moins de deux colonnes - </entry> - <entry> - Vérifiez la requête SQL ou choisissez une autre fonction - <function>get*</function> - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getrow"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link>, - <link linkend="package.database.db.db-common.getcol"> - <function>getCol</function></link> + <example> + <title> + Exemple avec <function>getAssoc</function> dans son mode par défaut + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => 1991-01-11 21:31:41 + [Kyu] => 1993-03-13 23:33:43 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 1992-02-12 22:32:42 + [1] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> + ]]> + </programlisting> + <para> + Affichera : </para> - </refsect1> - </refentry> + <screen> +<![CDATA[ +Array +( + [Juan] => stdClass Object + ( + [cf] => Juan + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => stdClass Object + ( + [cf] => Kyu + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [0] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [0] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ASSOC, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [df] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> + <![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_OBJECT, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => stdClass Object + ( + [cf] => Juan + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => stdClass Object + ( + [cf] => Kyu + [df] => 1992-02-12 22:32:42 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + </refsect2> + + + <refsect2 id="package.database.db.db-common.getassoc.example.more"> + <title>Le résultat a plus de deux colonnes</title> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 5 + [1] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 15 + [1] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => stdClass Object + ( + [cf] => Kyu + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// Once you have a valid DB object named $db... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [0] => 5 + [1] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [0] => 10 + [1] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [0] => 15 + [1] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ASSOC, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_OBJECT, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => stdClass Object + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + </refsect2> + + <refsect2 id="package.database.db.db-common.getassoc.example.params"> + <title>Mode Prepare / Execute</title> + + <example> + <title> + Utilisation de <function>getAssoc</function> + avec un marqueur + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo WHERE nf = ?', + false, 5); + +if (DB::isError($data)) { + die($data->getMessage()); +} +?> +]]> + </programlisting> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> + avec deux marqueurs + </title> + <programlisting role="php"> + <![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo WHERE nf IN (?, ?)', + false, array(5, 10)); + +if (DB::isError($data)) { + die($data->getMessage()); +} +?> + ]]> + </programlisting> + </example> + + </refsect2> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>, + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getcol"> + <function>getCol</function></link>, + <link linkend="package.database.db.db-common.getall"> + <function>getAll</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getcol.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getcol.xml diff -u peardoc/fr/package/database/db/db-common/getcol.xml:1.3 peardoc/fr/package/database/db/db-common/getcol.xml:1.4 --- peardoc/fr/package/database/db/db-common/getcol.xml:1.3 Fri Mar 5 12:57:12 2004 +++ peardoc/fr/package/database/db/db-common/getcol.xml Wed Jul 7 06:21:21 2004 @@ -1,206 +1,389 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.15 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.31 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getcol"> - <refnamediv> - <refname>DB_common::getCol()</refname> - <refpurpose>Récupère une seule colonne</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getCol</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$col = 0</optional></parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getcol.desc"> - &title.desc; + <refnamediv> + <refname>DB_common::getCol()</refname> + <refpurpose>Récupère une seule colonne</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getCol</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$col = 0</optional></parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$params = array()</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getcol.desc"> + &title.desc; + <para> + Exécute la requête et met la première colonne de données dans un tableau + et libère le résultat. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> + <listitem> + <para> + la requête SQL à préparer + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$col</parameter> + </term> + <listitem> + <para> + la colonne à retourner (integer [numéro de la colonne, on + commence à 0] ou string [nom de la colonne]) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau, chaîne ou données numériques à ajouter + à la requête préparée. + Le nombre d'éléments passés doit correspondre à + celui des marqueurs dans la requête préparée : un + marqueur pour les scalaires ou un marqueur par élément du + tableau pour un tableau. + </para> + <para> + Si ce paramètre est fourni, + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.return"> + &title.returns; + <para> + &type.array; - la première ligne du résultat en tant que tableau + indexé commençant à 0 ou + un objet &class.db-error; en cas d'erreur + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NOSUCHFIELD</constant></entry> + <entry> + no such field + </entry> + <entry> + Le nom/numéro de la colonne passé à <parameter>$col</parameter> + est invalide + </entry> + <entry> + Utilisez un nom/numéro de colonne qui existe dans le résultat de la requête. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="&url.php.manual;">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.example"> + &title.example; + <example> + <title> + Utilisation de <function>getCol</function> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> <para> - Récupère une seule colonne d'un résultat ou d'une requête. La fonction - prend soin d'exécuter la requête et de libérer le résultat par la suite. + Affichera : </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - la requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$col</parameter> - </term> - <listitem> - <para> - la colonne à retourner (integer [numéro de la colonne, on commence - à 0] ou string [nom de la colonne]) - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau, chaîne ou données numériques à ajouter à la requête préparée. - Le nombre d'éléments passés doit correspondre à celui des marqueurs - dans la requête préparée : un marqueur pour les scalaires ou un - marqueur par élément du tableau pour un tableau. - </para> - <para> - Si ce paramètre est fourni, - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.return"> - &title.returns; - <para> - <parameter>array</parameter> - la première ligne du résultat en tant que tableau - indexé commençant à 0 ou &class.db-error; en cas d'erreurs - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_TRUNCATED</constant></entry> - <entry> - &null; - </entry> - <entry> - Le résultat contient moins de deux colonnes - </entry> - <entry> - Vérifiez la requête SQL ou choisissez une autre fonction - <function>get*</function> - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getrow"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getAssoc</function></link> - </para> - </refsect1> - </refentry> + <screen> +<![CDATA[ +Array +( + [0] => Juan + [1] => Kyu +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> pour récupérer + une colonne numérique spécifique + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo', 1); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> + ]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> pour récupérer + une colonne nommée + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo', 'df'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> en mode prepare/execute + avec un marqueur + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo WHERE nf = ?', + 'df', 5); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> en mode prepare/execute + avec deux marqueurs + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo WHERE nf IN (?, ?)', + 'df', array(5, 10)); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getassoc"> + <function>getAssoc</function></link>, + <link linkend="package.database.db.db-common.getall"> + <function>getAll</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml
http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/freeprepared.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/fr/package/database/db/db-common/freeprepared.xml diff -u peardoc/fr/package/database/db/db-common/freeprepared.xml:1.1 peardoc/fr/package/database/db/db-common/freeprepared.xml:1.2 --- peardoc/fr/package/database/db/db-common/freeprepared.xml:1.1 Sat Feb 21 21:04:07 2004 +++ peardoc/fr/package/database/db/db-common/freeprepared.xml Wed Jul 7 06:21:21 2004 @@ -1,79 +1,95 @@ -<!-- $Revision: 1.1 $ --> -<!-- EN-Revision: 1.2 Maintainer: didou Status: ready --> -<refentry id="package.database.db.db-common.freeprepared"> - - <refnamediv> - <refname>DB_common::freePrepared()</refname> - <refpurpose>Libère les ressources associées à une requête SQL préparée</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>freePrepared</function></funcdef> - <paramdef>resource <parameter>$stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1 id="package.database.db.db-common.freeprepared.desc"> - &title.desc; - <para> - Détruit la mémoire occupée par la notation interne qui surveille les - requêtes SQL préparées. - Cette fonction <emphasis>n'efface pas</emphasis> l'objet &class.db-result; - lui-même. - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.resource; - <parameter>$stmt</parameter> - </term> - <listitem> - <para> - identifiant de ressource retourné par <function>prepare</function> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.return"> - &title.returns; - <para> - <itemizedlist> - <listitem> - <para> - <parameter>boolean</parameter> - &return.success; - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.note"> - &title.note; - ¬e.notstatic; - </refsect1> - - <refsect1 id="package.database.db.db-common.freeprepared.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-result.free"> - <function>free</function></link> - </para> - </refsect1> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.2 $ --> +<!-- EN-Revision: 1.10 Maintainer: didou Status: ready --> - </refentry> +<refentry id="package.database.db.db-common.freeprepared"> + <refnamediv> + <refname>DB_common::freePrepared()</refname> + <refpurpose>Libère les ressources associées à une requête SQL préparée</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>boolean <function>freePrepared</function></funcdef> + <paramdef> + resource <parameter>$stmt</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.freeprepared.desc"> + &title.desc; + <para> + Détruit la mémoire occupée par la notation + interne qui surveille les requêtes SQL préparées. + Cette fonction <emphasis>n'efface pas</emphasis> l'objet &class.db-result; + lui-même. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.resource; + <parameter>$stmt</parameter> + </term> + <listitem> + <para> + identifiant de ressource retourné + par <function>prepare</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.return"> + &title.returns; + <para> + &type.bool; - &return.success; + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.example"> + &title.example; + <example> + <title>Exemple avec <function>freePrepared</function></title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$sth = $db->prepare('INSERT INTO numbers (number) VALUES (?)'); +$db->execute($sth, 1); +$db->freePrepared($sth); +?> +]]> + </programlisting> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.freeprepared.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link>, + <link linkend="package.database.db.db-common.autoprepare"> + <function>autoPrepare</function></link>, + <link linkend="package.database.db.db-result.free"> + <function>free</function></link> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getall.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getall.xml diff -u peardoc/fr/package/database/db/db-common/getall.xml:1.3 peardoc/fr/package/database/db/db-common/getall.xml:1.4 --- peardoc/fr/package/database/db/db-common/getall.xml:1.3 Fri Feb 20 11:30:19 2004 +++ peardoc/fr/package/database/db/db-common/getall.xml Wed Jul 7 06:21:21 2004 @@ -1,202 +1,559 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.14 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.33 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getall"> - <refnamediv> - <refname>DB_common::getAll()</refname> - <refpurpose>Récupère toutes les lignes</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getAll</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - <paramdef> - integer <parameter><optional>$fetchmode = + <refnamediv> + <refname>DB_common::getAll()</refname> + <refpurpose>Récupère toutes les lignes</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getAll</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + array <parameter><optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + integer <parameter><optional>$fetchmode = <constant>DB_FETCHMODE_DEFAULT</constant></optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getall.desc"> - &title.desc; - <para> - Récupère le résultat entier d'une requête dans un tableau imbriqué. - La fonction prend soin d'exécuter la requête et de libérer le résultat - à la fin. - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - La requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau à utiliser dans l'exécution de la requête. - Le nombre d'éléments du tableau doit correspondre au nombre - de marqueurs dans la requête. Cette fonction ne supporte PAS - les scalaires. - </para> - <para> - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.int; - <parameter>$fetchmode</parameter> - </term> - <listitem> - <para> - le mode de récupération à utiliser, - par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.return"> - &title.returns; - <para> - <itemizedlist> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getall.desc"> + &title.desc; + <para> + Récupère le résultat entier d'une requête + dans un tableau imbriqué. + La fonction prend soin d'exécuter la requête et de + libérer le résultat à la fin. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> <listitem> <para> - <parameter>array</parameter> - un tableau imbriqué, ou - &class.db-error; en cas d'erreurs + La requête SQL à préparer </para> </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getall.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getall.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getcol"> - <function>getCol</function></link>, - <link linkend="package.database.db.db-common.getall"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getassoc"> - <function>getAssoc</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link> - </para> - </refsect1> - </refentry> + </varlistentry> + <varlistentry> + <term> + &type.array; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau à utiliser dans l'exécution de la requête. + Le nombre d'éléments du tableau doit correspondre au nombre + de marqueurs dans la requête. + </para> + <para> + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + <warning> + <para> + Cette méthode n'autorise pas les scalaires en tant qu'argument. + </para> + </warning> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.int; + <parameter>$fetchmode</parameter> + </term> + <listitem> + <para> + le mode de récupération à utiliser. + Par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant>, + qui demande à la méthode d'utiliser le mode de récupération courant + de DB. Le mode de récupération courant peut être changé + en utilisant + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>. + Les valeurs possibles sont : + <itemizedlist> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_OBJECT</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> | + <constant>DB_FETCHMODE_FLIPPED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> | + <constant>DB_FETCHMODE_FLIPPED</constant> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.return"> + &title.returns; + <para> + &type.array; - un tableau imbriqué ou + un objet &class.db-error; en cas d'erreurs + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="www.php.net/manual/">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.example"> + &title.example; + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif en définissant le mode de récupération par défaut + en premier + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$db->setFetchMode(DB_FETCHMODE_ASSOC); +$data =& $db->getAll('SELECT cf, nf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner + un tableau ordonné + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [0] => Juan + [1] => 5 + [2] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [0] => Kyu + [1] => 10 + [2] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau ordonné et inversé + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ORDERED | DB_FETCHMODE_FLIPPED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [0] => Juan + [1] => Kyu + ) + [1] => Array + ( + [0] => 5 + [1] => 10 + ) + [2] => Array + ( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => Array + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau associatif inversé + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_ASSOC | DB_FETCHMODE_FLIPPED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [cf] => Array + ( + [0] => Juan + [1] => Kyu + ) + [nf] => Array + ( + [0] => 5 + [1] => 10 + ) + [df] => Array + ( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> pour retourner un + tableau d'objets + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo', + array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAll</function> dans un mode prepare/execute + pour retourner un tableau associatif + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAll('SELECT cf, nf, df FROM foo WHERE nf = ?', + array(5), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => Array + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) +) +]]> + </screen> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.getall.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>, + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getcol"> + <function>getCol</function></link>, + <link linkend="package.database.db.db-common.getassoc"> + <function>getAssoc</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getassoc.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getassoc.xml diff -u peardoc/fr/package/database/db/db-common/getassoc.xml:1.3 peardoc/fr/package/database/db/db-common/getassoc.xml:1.4 --- peardoc/fr/package/database/db/db-common/getassoc.xml:1.3 Fri Mar 5 12:57:12 2004 +++ peardoc/fr/package/database/db/db-common/getassoc.xml Wed Jul 7 06:21:21 2004 @@ -1,252 +1,1027 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.16 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.35 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getassoc"> - <refnamediv> - <refname>DB_common::getAssoc()</refname> - <refpurpose>Récupère le résultat dans un tableau associatif</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getAssoc</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - boolean <parameter> - <optional>$force_array = &false;</optional></parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - <paramdef>integer - <parameter><optional>$fetchmode = - <constant>DB_FETCHMODE_DEFAULT</constant> - </optional></parameter> - </paramdef> - <paramdef> boolean - <parameter><optional>$group = &false;</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getassoc.desc"> - &title.desc; + <refnamediv> + <refname>DB_common::getAssoc()</refname> + <refpurpose>Récupère le résultat dans un tableau </refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getAssoc</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + boolean <parameter><optional>$force_array = &false;</optional></parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$params = array()</optional></parameter> + </paramdef> + <paramdef> + integer <parameter><optional>$fetchmode = + <constant>DB_FETCHMODE_DEFAULT</constant></optional></parameter> + </paramdef> + <paramdef> + boolean <parameter><optional>$group = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getassoc.desc"> + &title.desc; + <para> + Exécute la requête et met la totalité du résultat + dans un tableau associatif et libère le résultat. + </para> + <para> + Si le résultat contient plus de deux colonnes, les valeurs seront + un tableau des valeurs allant des colonnes 2 à n. Si le résultat ne + contient que deux colonnes, la valeur retournée est un scalaire + avec la valeur de la seconde colonne (sauf si vous forcez l'obtention + d'un tableau avec la paramètre <parameter>$force_array</parameter>). + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> + <listitem> + <para> + la requête SQL à préparer + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.bool; + <parameter>$force_array</parameter> + </term> + <listitem> + <para> + utilisé seulement si la requête retourne exactement deux colonnes. + Si &true;, les valeurs du tableau retourné seront des tableaux à + un élément au lieu de scalaires. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau, chaîne ou données numériques à + ajouter à la requête préparée. + Le nombre d'éléments passés doit correspondre + à celui des marqueurs dans la requête + préparée : un marqueur pour les scalaires ou un + marqueur par élément du tableau pour un tableau. + </para> + <para> + Si ce paramètre est fourni, + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.int; + <parameter>$fetchmode</parameter> + </term> + <listitem> + <para> + le mode de récupération à utiliser. + Par défaut, c'est <constant>DB_FETCHMODE_DEFAULT</constant>, + qui demande à la méthode d'utiliser le mode de récupération + courant de DB. + Le mode de récupération courant de DB peut être modifier + en utilisant + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>. + Les valeurs possibles sont : + <itemizedlist> + <listitem> + <para> + <constant>DB_FETCHMODE_ORDERED</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_ASSOC</constant> + </para> + </listitem> + <listitem> + <para> + <constant>DB_FETCHMODE_OBJECT</constant> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.bool; + <parameter>$group</parameter> + </term> + <listitem> + <para> + si &true;, les valeurs du tableau retournées sont enveloppés + dans un autre tableau. + Si la même valeur de clef (dans la première colonne) + se répète, les valeurs seront ajoutées à la fin de + ce tableau, au lieu d'écraser les valeurs existantes. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.return"> + &title.returns; + <para> + &type.array; - tableau associatif avec les résultats de + la requête ou un objet &class.db-error; en cas d'erreur. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_TRUNCATED</constant></entry> + <entry> + truncated + </entry> + <entry> + Le résultat contient moins de deux colonnes + </entry> + <entry> + Vérifiez la requête SQL ou choisissez une autre fonction + <function>get*</function> + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="www.php.net/manual/">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.example"> + &title.example; + <para> + Tous les exemples utilisent les données suivantes : + <programlisting role="sql"> +<![CDATA[ +INSERT INTO foo VALUES ('Juan', 5, '1991-01-11 21:31:41'); +INSERT INTO foo VALUES ('Kyu', 10, '1992-02-12 22:32:42'); +INSERT INTO foo VALUES ('Kyu', 15, '1993-03-13 23:33:43'); +]]> + </programlisting> + </para> + + <refsect2 id="package.database.db.db-common.getassoc.example.two"> + <title>Le résultat a deux colonnes</title> <para> - Récupère le résultat dans un tableau associatif en utilisant - la première colonne en tant que clef. La fonction prend soin d'exécuter - la requête et de libérer les résultats à la fin de son exécution. - - Si le résultat contient plus de deux colonnes, les valeurs seront - un tableau des valeurs allant des colonnes 2 à n. Si le résultat ne - contient que deux colonnes, la valeur retournée est un scalaire - avec la valeur de la seconde colonne (sauf si vous forcez l'obtention - d'un tableau avec la paramètre $force_array). + Lorsque vous utilisez <function>getAssoc</function> pour récupérer le résultat + qui a deux colonnes et + <parameter>$force_array</parameter> = &false; (par défaut), + changer <parameter>$fetchmode</parameter> n'aura aucun effet sur le format + du tableau résultant. </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - la requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.bool; - <parameter>$force_array</parameter> - </term> - <listitem> - <para> - utilisé seulement si la requête retourne exactement deux colonnes. - Si &true;, les valeurs du tableau retourné seront des tableaux à un élément - au lieu de scalaires. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau, chaîne ou données numériques à - ajouter à la requête préparée. - Le nombre d'éléments passés doit correspondre - à celui des marqueurs dans la requête - préparée : un marqueur pour les scalaires ou un - marqueur par élément du tableau pour un tableau. - </para> - <para> - Si ce paramètre est fourni, - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.int; - <parameter>$fetchmode</parameter> - </term> - <listitem> - <para> - le mode de récupération à utiliser - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.bool; - <parameter>boolean $group</parameter> - </term> - <listitem> - <para> - si &true;, les valeurs du tableau retournées sont enveloppés dans un - autre tableau. - Si la même valeur de clef (dans la première colonne) - se répète, les valeurs seront ajoutées à la fin de ce tableau, au lieu - d'écraser les valeurs existantes. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.return"> - &title.returns; - <para> - <parameter>array</parameter> - tableau associatif avec les résultats de - la requête. - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_TRUNCATED</constant></entry> - <entry> - &null; - </entry> - <entry> - Le résultat contient moins de deux colonnes - </entry> - <entry> - Vérifiez la requête SQL ou choisissez une autre fonction - <function>get*</function> - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getassoc.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getrow"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link>, - <link linkend="package.database.db.db-common.getcol"> - <function>getCol</function></link> + <example> + <title> + Exemple avec <function>getAssoc</function> dans son mode par défaut + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => 1991-01-11 21:31:41 + [Kyu] => 1993-03-13 23:33:43 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 1992-02-12 22:32:42 + [1] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true; + et <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> + ]]> + </programlisting> + <para> + Affichera : </para> - </refsect1> - </refentry> + <screen> +<![CDATA[ +Array +( + [Juan] => stdClass Object + ( + [cf] => Juan + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => stdClass Object + ( + [cf] => Kyu + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [0] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [0] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [0] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_ASSOC, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [df] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$force_array</parameter> = &true;, + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> + <![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo', + true, array(), DB_FETCHMODE_OBJECT, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => stdClass Object + ( + [cf] => Juan + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => stdClass Object + ( + [cf] => Kyu + [df] => 1992-02-12 22:32:42 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + </refsect2> + + + <refsect2 id="package.database.db.db-common.getassoc.example.more"> + <title>Le résultat a plus de deux colonnes</title> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => 5 + [1] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [0] => 15 + [1] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ASSOC); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => Array + ( + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_OBJECT); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + [Kyu] => stdClass Object + ( + [cf] => Kyu + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ORDERED</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// Once you have a valid DB object named $db... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ORDERED, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [0] => 5 + [1] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [0] => 10 + [1] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [0] => 15 + [1] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_ASSOC</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_ASSOC, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => Array + ( + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => Array + ( + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) + [1] => Array + ( + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> avec + <parameter>$fetchmode</parameter> = + <constant>DB_FETCHMODE_OBJECT</constant> + et <parameter>$group</parameter> = &true; + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, nf, df FROM foo', + false, array(), DB_FETCHMODE_OBJECT, true); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [Juan] => Array + ( + [0] => stdClass Object + ( + [cf] => Juan + [nf] => 5 + [df] => 1991-01-11 21:31:41 + ) + ) + [Kyu] => Array + ( + [0] => stdClass Object + ( + [cf] => Kyu + [nf] => 10 + [df] => 1992-02-12 22:32:42 + ) + [1] => stdClass Object + ( + [cf] => Kyu + [nf] => 15 + [df] => 1993-03-13 23:33:43 + ) + ) +) +]]> + </screen> + </example> + + </refsect2> + + <refsect2 id="package.database.db.db-common.getassoc.example.params"> + <title>Mode Prepare / Execute</title> + + <example> + <title> + Utilisation de <function>getAssoc</function> + avec un marqueur + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo WHERE nf = ?', + false, 5); + +if (DB::isError($data)) { + die($data->getMessage()); +} +?> +]]> + </programlisting> + </example> + + <example> + <title> + Utilisation de <function>getAssoc</function> + avec deux marqueurs + </title> + <programlisting role="php"> + <![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getAssoc('SELECT cf, df FROM foo WHERE nf IN (?, ?)', + false, array(5, 10)); + +if (DB::isError($data)) { + die($data->getMessage()); +} +?> + ]]> + </programlisting> + </example> + + </refsect2> + </refsect1> + + <refsect1 id="package.database.db.db-common.getassoc.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.setfetchmode"> + <function>setFetchMode</function></link>, + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getcol"> + <function>getCol</function></link>, + <link linkend="package.database.db.db-common.getall"> + <function>getAll</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db-common/getcol.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db-common/getcol.xml diff -u peardoc/fr/package/database/db/db-common/getcol.xml:1.3 peardoc/fr/package/database/db/db-common/getcol.xml:1.4 --- peardoc/fr/package/database/db/db-common/getcol.xml:1.3 Fri Mar 5 12:57:12 2004 +++ peardoc/fr/package/database/db/db-common/getcol.xml Wed Jul 7 06:21:21 2004 @@ -1,206 +1,389 @@ -<!-- $Revision: 1.3 $ --> -<!-- EN-Revision: 1.15 Maintainer: didou Status: ready --> +<?xml version="1.0" encoding="iso-8859-1" ?> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.31 Maintainer: didou Status: ready --> + <refentry id="package.database.db.db-common.getcol"> - <refnamediv> - <refname>DB_common::getCol()</refname> - <refpurpose>Récupère une seule colonne</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>&getCol</function></funcdef> - <paramdef> - string <parameter>$query</parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$col = 0</optional></parameter> - </paramdef> - <paramdef> - mixed <parameter><optional>$params</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - <refsect1 id="package.database.db.db-common.getcol.desc"> - &title.desc; + <refnamediv> + <refname>DB_common::getCol()</refname> + <refpurpose>Récupère une seule colonne</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>&getCol</function></funcdef> + <paramdef> + string <parameter>$query</parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$col = 0</optional></parameter> + </paramdef> + <paramdef> + mixed <parameter><optional>$params = array()</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id="package.database.db.db-common.getcol.desc"> + &title.desc; + <para> + Exécute la requête et met la première colonne de données dans un tableau + et libère le résultat. + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.string; + <parameter>$query</parameter> + </term> + <listitem> + <para> + la requête SQL à préparer + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$col</parameter> + </term> + <listitem> + <para> + la colonne à retourner (integer [numéro de la colonne, on + commence à 0] ou string [nom de la colonne]) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + &type.mixed; + <parameter>$params</parameter> + </term> + <listitem> + <para> + tableau, chaîne ou données numériques à ajouter + à la requête préparée. + Le nombre d'éléments passés doit correspondre à + celui des marqueurs dans la requête préparée : un + marqueur pour les scalaires ou un marqueur par élément du + tableau pour un tableau. + </para> + <para> + Si ce paramètre est fourni, + <link linkend="package.database.db.intro-execute"> + <function>prepare</function>/ + <function>execute</function></link> sont utilisées. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.return"> + &title.returns; + <para> + &type.array; - la première ligne du résultat en tant que tableau + indexé commençant à 0 ou + un objet &class.db-error; en cas d'erreur + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.throws"> + &title.throws; + <para> + <table> + <title>&title.throws.errortable;</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Code erreur</entry> + <entry>Message erreur</entry> + <entry>Raison</entry> + <entry>Solution</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>DB_ERROR_INVALID</constant></entry> + <entry> + invalid + </entry> + <entry> + La requête SQL à préparer n'est pas valide. + </entry> + <entry> + Voyez la <link linkend="package.database.db.db-common.prepare"> + documentation de <function>prepare</function></link>, + si vous voulez utiliser une requête SQL avec des marqueurs. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_MISMATCH</constant></entry> + <entry> + mismatch + </entry> + <entry> + Le nombre de paramètres ne correspond pas au nombre de marqueurs + dans la requête préparée. + </entry> + <entry> + Vérifiez le nombre de marqueurs dans la requête + <link linkend="package.database.db.db-common.prepare"> + <function>prepare</function></link> passée à + <parameter>$query</parameter>. Il doit être égal au nombre + d'entrées passées à + <parameter>$params</parameter>. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NOSUCHFIELD</constant></entry> + <entry> + no such field + </entry> + <entry> + Le nom/numéro de la colonne passé à <parameter>$col</parameter> + est invalide + </entry> + <entry> + Utilisez un nom/numéro de colonne qui existe dans le résultat de la requête. + </entry> + </row> + <row> + <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> + <entry> + no database selected + </entry> + <entry> + Aucune base de données n'a été + sélectionnée. + </entry> + <entry> + Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> + dans <link linkend="package.database.db.db.connect"> + <function>connect</function></link>. + </entry> + </row> + <row> + <entry>tout autre code erreur</entry> + <entry></entry> + <entry> + Erreur spécifique à la base de données. + </entry> + <entry> + Vérifiez la section spécifique à la base de + données dans le + <ulink url="&url.php.manual;">manuel PHP</ulink> + pour trouver la raison de cette erreur. Dans la plupart des cas, il + s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans + une requête envoyée à une base de données + Oracle. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.note"> + &title.note; + ¬e.notstatic; + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.example"> + &title.example; + <example> + <title> + Utilisation de <function>getCol</function> + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> <para> - Récupère une seule colonne d'un résultat ou d'une requête. La fonction - prend soin d'exécuter la requête et de libérer le résultat par la suite. + Affichera : </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.parameter"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.string; - <parameter>$query</parameter> - </term> - <listitem> - <para> - la requête SQL à préparer - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$col</parameter> - </term> - <listitem> - <para> - la colonne à retourner (integer [numéro de la colonne, on commence - à 0] ou string [nom de la colonne]) - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - &type.mixed; - <parameter>$params</parameter> - </term> - <listitem> - <para> - tableau, chaîne ou données numériques à ajouter à la requête préparée. - Le nombre d'éléments passés doit correspondre à celui des marqueurs - dans la requête préparée : un marqueur pour les scalaires ou un - marqueur par élément du tableau pour un tableau. - </para> - <para> - Si ce paramètre est fourni, - <link linkend="package.database.db.intro-execute"> - <function>prepare</function>/ - <function>execute</function></link> sont utilisées. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.return"> - &title.returns; - <para> - <parameter>array</parameter> - la première ligne du résultat en tant que tableau - indexé commençant à 0 ou &class.db-error; en cas d'erreurs - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.throws"> - &title.throws; - <para> - <table> - <title>&title.throws.errortable;</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Code erreur</entry> - <entry>Message erreur</entry> - <entry>Raison</entry> - <entry>Solution</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>DB_ERROR_INVALID</constant></entry> - <entry> - &null; - </entry> - <entry> - La requête SQL à préparer n'est pas valide. - </entry> - <entry> - Voyez la <link linkend="package.database.db.db-common.prepare"> - documentation de <function>prepare</function></link>, - si vous voulez utiliser une requête SQL avec des marqueurs. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_MISMATCH</constant></entry> - <entry> - &null; - </entry> - <entry> - Le nombre de paramètres ne correspond pas au nombre de marqueurs - dans la requête préparée. - </entry> - <entry> - Vérifiez le nombre de marqueurs dans la requête - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link> passée à - <parameter>$query</parameter>. Il doit être égal au nombre - d'entrées passées à <parameter>$params</parameter>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_NODBSELECTED</constant></entry> - <entry> - &null; - </entry> - <entry> - Aucune base de données n'a été sélectionnée. - </entry> - <entry> - Vérifiez le <link linkend="package.database.db.intro-dsn">DSN</link> - dans <link linkend="package.database.db.db.connect"> - <function>connect</function></link>. - </entry> - </row> - <row> - <entry><constant>DB_ERROR_TRUNCATED</constant></entry> - <entry> - &null; - </entry> - <entry> - Le résultat contient moins de deux colonnes - </entry> - <entry> - Vérifiez la requête SQL ou choisissez une autre fonction - <function>get*</function> - </entry> - </row> - <row> - <entry>tout autre code erreur</entry> - <entry></entry> - <entry> - Erreur spécifique à la base de données. - </entry> - <entry> - Vérifiez la section spécifique à la base de données dans le - <ulink url="www.php.net/manual/">manuel PHP</ulink> - pour trouver la raison de cette erreur. Dans la plupart des cas, il - s'agit d'une requête mal formée. Comme l'utilisation de LIMIT dans - une requête envoyée à une base de données Oracle. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.note"> - &title.note; - ¬e.notstatic; - </refsect1> - <refsect1 id="package.database.db.db-common.getcol.see"> - &title.see; - <para> - <link linkend="package.database.db.db-common.query"> - <function>query</function></link>, - <link linkend="package.database.db.db-common.limitquery"> - <function>limitQuery</function></link>, - <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>, - <link linkend="package.database.db.db-common.execute"> - <function>execute</function></link>, - <link linkend="package.database.db.db-common.getrow"> - <function>getRow</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getOne</function></link>, - <link linkend="package.database.db.db-common.getone"> - <function>getAssoc</function></link> - </para> - </refsect1> - </refentry> + <screen> +<![CDATA[ +Array +( + [0] => Juan + [1] => Kyu +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> pour récupérer + une colonne numérique spécifique + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo', 1); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> + ]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> pour récupérer + une colonne nommée + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo', 'df'); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> en mode prepare/execute + avec un marqueur + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo WHERE nf = ?', + 'df', 5); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 +) +]]> + </screen> + </example> + + <example> + <title> + Utilisation de <function>getCol</function> en mode prepare/execute + avec deux marqueurs + </title> + <programlisting role="php"> +<![CDATA[ +<?php +// On suppose que $db est un objet DB valide... +$data =& $db->getCol('SELECT cf, df FROM foo WHERE nf IN (?, ?)', + 'df', array(5, 10)); + +if (DB::isError($data)) { + die($data->getMessage()); +} + +print_r($data); +?> +]]> + </programlisting> + <para> + Affichera : + </para> + <screen> +<![CDATA[ +Array +( + [0] => 1991-01-11 21:31:41 + [1] => 1992-02-12 22:32:42 +) +]]> + </screen> + </example> + </refsect1> + + <refsect1 id="package.database.db.db-common.getcol.see"> + &title.see; + <para> + <link linkend="package.database.db.db-common.getone"> + <function>getOne</function></link>, + <link linkend="package.database.db.db-common.getrow"> + <function>getRow</function></link>, + <link linkend="package.database.db.db-common.getassoc"> + <function>getAssoc</function></link>, + <link linkend="package.database.db.db-common.getall"> + <function>getAll</function></link>, + <link linkend="package.database.db.db-common.query"> + <function>query</function></link>, + <link linkend="package.database.db.intro-execute"> + <quote>Introduction - Préparation & Exécution</quote></link> + </para> + </refsect1> +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml