1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.dbase-replace-record">
<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>int</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>array</type><parameter>record</parameter></methodparam>
<methodparam><type>int</type><parameter>record_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>dbase_identifier</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record</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_add_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>record_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="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');
// Replace the record
dbase_replace_record($db, $row, 1);
dbase_close($db);
}
?>
]]>
</programlisting>
</example>
</para>
</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:"../../../../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
-->
|