doc-fr/reference/pgsql/functions/pg-update.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.pg-update" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_update</refname>
  <refpurpose>
   Modifie les lignes d'une table
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>pg_update</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>data</parameter></methodparam>
   <methodparam><type>array</type><parameter>condition</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>PGSQL_DML_EXEC</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_update</function> modifie les lignes de la table
   <parameter>table_name</parameter>, qui vérifient la condition
   <literal>condition</literal>, et leur donne la valeur de <literal>data</literal>. 
   Si <literal>options</literal> est spécifié, 
   <function>pg_convert</function> est appliqué à 
   <literal>data</literal> avec les options spécifiées.
  </para>
  &warn.experimental.func;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Une ressource de connexion PostgreSQL.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Le nom de la table dans laquelle les lignes seront mises à jour.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Un &array; dont les clés sont les noms des champs dans la table
       <parameter>table_name</parameter>, et où les valeurs 
       sont les lignes correspondantes qui seront mises à jour.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>condition</parameter></term>
     <listitem>
      <para>
       Un &array; dont les clés sont les noms des champs dans la table
       <parameter>table_name</parameter>, et où les valeurs sont
       les conditions à remplir par les lignes pour être mises à jour.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Toutes combinaisons de constantes parmi
       <constant>PGSQL_CONV_OPTS</constant>, 
       <constant>PGSQL_DML_NO_CONV</constant>,
       <constant>PGSQL_DML_EXEC</constant> ou
       <constant>PGSQL_DML_STRING</constant>.
       Si <constant>PGSQL_DML_STRING</constant> fait partie du paramètre
       <parameter>options</parameter>, alors la requête sera retournée.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;  Retourne une &string; si <constant>PGSQL_DML_STRING</constant> est passé
   via le paramètre <parameter>options</parameter>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>pg_update</function></title>
    <programlisting role="php">
<![CDATA[
<?php 
  $db = pg_connect ('dbname=foo');
  $data = array('field1'=>'AA', 'field2'=>'BB');

  // C'est sécuritaire, car $_POST est convertit automatiquement
  $res = pg_update($db, 'post_log', $_POST, $data);
  if ($res) {
      echo "Les données ont été modifiées : $res\n";
  } else {
      echo "Problème dans les données utilisateur\n";
  }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_convert</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->