<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.dbase.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.dbase-replace-record.php',
    1 => 'dbase_replace_record',
    2 => 'Replaces a record in a database',
  ),
  'up' => 
  array (
    0 => 'ref.dbase.php',
    1 => 'dBase Functions',
  ),
  'prev' => 
  array (
    0 => 'function.dbase-pack.php',
    1 => 'dbase_pack',
  ),
  'next' => 
  array (
    0 => 'book.ibase.php',
    1 => 'Firebird/InterBase',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/dbase/functions/dbase-replace-record.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.dbase-replace-record" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">dbase_replace_record</h1>
  <p class="verinfo">(PHP 5 &lt; 5.3.0, dbase 5, dbase 7)</p><p class="refpurpose"><span class="refname">dbase_replace_record</span> &mdash; <span class="dc-title">Replaces a record in a database</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.dbase-replace-record-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>dbase_replace_record</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$database</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$number</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Replaces the given record in the database with the given data.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.dbase-replace-record-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">database</code></dt>
     <dd>
      <p class="para">
       The database resource, returned by <span class="function"><a href="function.dbase-open.php" class="function">dbase_open()</a></span>
       or <span class="function"><a href="function.dbase-create.php" class="function">dbase_create()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       An indexed array of data. The number of items must be equal to the
       number of fields in the database, otherwise
       <span class="function"><strong>dbase_replace_record()</strong></span> will fail.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        If you&#039;re using <span class="function"><a href="function.dbase-get-record.php" class="function">dbase_get_record()</a></span> return value for this
        parameter, remember to reset the key named <code class="literal">deleted</code>.
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">number</code></dt>
     <dd>
      <p class="para">
       An integer which spans from 1 to the number of records in the database
       (as returned by <span class="function"><a href="function.dbase-numrecords.php" class="function">dbase_numrecords()</a></span>).
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.dbase-replace-record-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.dbase-replace-record-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>PECL dbase 7.0.0</td>
      <td>
       <code class="parameter">database</code> is now a <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>
       instead of an <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.dbase-replace-record-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 Updating a record in the database</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// open in read-write mode<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'/tmp/test.dbf'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$db</span><span style="color: #007700">) {<br />  </span><span style="color: #FF8000">// gets the old row<br />  </span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_get_record_with_names</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />  <br />  </span><span style="color: #FF8000">// remove the 'deleted' entry<br />  </span><span style="color: #007700">unset(</span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'deleted'</span><span style="color: #007700">]);<br />  <br />  </span><span style="color: #FF8000">// Update the date field with the current timestamp<br />  </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'date'</span><span style="color: #007700">] = </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">'Ymd'</span><span style="color: #007700">);<br />  <br />  </span><span style="color: #FF8000">// convert the row to an indexed array<br />  </span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">array_values</span><span style="color: #007700">(</span><span style="color: #0000BB">$row</span><span style="color: #007700">);<br /><br />  </span><span style="color: #FF8000">// Replace the record<br />  </span><span style="color: #0000BB">dbase_replace_record</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$row</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />  </span><span style="color: #0000BB">dbase_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.dbase-replace-record-notes">
  <h3 class="title">Notes</h3>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Boolean fields result in an <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> element value
    (<code class="literal">0</code> or <code class="literal">1</code>) when retrieved via
    <span class="function"><a href="function.dbase-get-record.php" class="function">dbase_get_record()</a></span> or
    <span class="function"><a href="function.dbase-get-record-with-names.php" class="function">dbase_get_record_with_names()</a></span>. If they are written back,
    this results in the value becoming <code class="literal">0</code>, so care has to be
    taken to properly adjust the values.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.dbase-replace-record-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.dbase-add-record.php" class="function" rel="rdfs-seeAlso">dbase_add_record()</a> - Adds a record to a database</span></li>
    <li><span class="function"><a href="function.dbase-delete-record.php" class="function" rel="rdfs-seeAlso">dbase_delete_record()</a> - Deletes a record from a database</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>