<?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-numrecords.php',
    1 => 'dbase_numrecords',
    2 => 'Gets the number of records in a database',
  ),
  'up' => 
  array (
    0 => 'ref.dbase.php',
    1 => 'dBase Functions',
  ),
  'prev' => 
  array (
    0 => 'function.dbase-numfields.php',
    1 => 'dbase_numfields',
  ),
  'next' => 
  array (
    0 => 'function.dbase-open.php',
    1 => 'dbase_open',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/dbase/functions/dbase-numrecords.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.dbase-numrecords" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">dbase_numrecords</h1>
  <p class="verinfo">(PHP 5 &lt; 5.3.0, dbase 5, dbase 7)</p><p class="refpurpose"><span class="refname">dbase_numrecords</span> &mdash; <span class="dc-title">Gets the number of records in a database</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.dbase-numrecords-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>dbase_numrecords</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="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

  <p class="para rdfs-comment">
   Gets the number of records (rows) in the specified database.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Records which are marked as deleted are counted as well.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Record numbers are between 1 and <code class="literal">dbase_numrecords($db)</code>,
    while field numbers are between 0 and <code class="literal">dbase_numfields($db)-1</code>.
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.dbase-numrecords-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>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.dbase-numrecords-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   The number of records in the database, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> if an error occurs.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.dbase-numrecords-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-numrecords-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 Looping over all the records of 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-only 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">0</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$db</span><span style="color: #007700">) {<br />  </span><span style="color: #0000BB">$record_numbers </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_numrecords</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">);<br />  for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">&lt;= </span><span style="color: #0000BB">$record_numbers</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br />      </span><span style="color: #0000BB">$record </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_get_record</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />      if (!</span><span style="color: #0000BB">$record</span><span style="color: #007700">[</span><span style="color: #DD0000">'deleted'</span><span style="color: #007700">]) {<br />          </span><span style="color: #FF8000">// do something with the $record<br />      </span><span style="color: #007700">} else {<br />          </span><span style="color: #FF8000">// do something with the deleted $record or ignore it<br />      </span><span style="color: #007700">}<br />  }<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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

 <div class="refsect1 seealso" id="refsect1-function.dbase-numrecords-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.dbase-numfields.php" class="function" rel="rdfs-seeAlso">dbase_numfields()</a> - Gets the number of fields of a database</span></li>
   </ul>
  </p>
 </div>

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