<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbase-replace-record" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_replace_record</refname>
  <refpurpose>Replaces a record in a database</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>dbase_replace_record</methodname>
   <methodparam><type>resource</type><parameter>database</parameter></methodparam>
   <methodparam><type>array</type><parameter>data</parameter></methodparam>
   <methodparam><type>int</type><parameter>number</parameter></methodparam>
  </methodsynopsis>
  <para>
   Replaces the given record in the database with the given data.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       The database resource, returned by <function>dbase_open</function>
       or <function>dbase_create</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       An indexed array of data. The number of items must be equal to the
       number of fields in the database, otherwise
       <function>dbase_replace_record</function> will fail.
      </para>
      <note>
       <para>
        If you're using <function>dbase_get_record</function> return value for this
        parameter, remember to reset the key named <literal>deleted</literal>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>number</parameter></term>
     <listitem>
      <para>
       An integer which spans from 1 to the number of records in the database
       (as returned by <function>dbase_numrecords</function>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>dbase 7.0.0</entry>
      <entry>
       <parameter>database</parameter> is now a <type>resource</type>
       instead of an <type>int</type>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Updating a record in the database</title>
    <programlisting role="php">
<![CDATA[
<?php

// open in read-write mode
$db = dbase_open('/tmp/test.dbf', 2);

if ($db) {
  // gets the old row
  $row = dbase_get_record_with_names($db, 1);
  
  // remove the 'deleted' entry
  unset($row['deleted']);
  
  // Update the date field with the current timestamp
  $row['date'] = date('Ymd');
  
  // convert the row to an indexed array
  $row = array_values($row);

  // Replace the record
  dbase_replace_record($db, $row, 1);
  dbase_close($db);
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  <note>
   <para>
    Boolean fields result in an <type>int</type> element value
    (<literal>0</literal> or <literal>1</literal>) when retrieved via
    <function>dbase_get_record</function> or
    <function>dbase_get_record_with_names</function>. If they are written back,
    this results in the value becoming <literal>0</literal>, so care has to be
    taken to properly adjust the values.
   </para>
  </note>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dbase_add_record</function></member>
    <member><function>dbase_delete_record</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
-->
