php-doc-en/reference/dbase/functions/dbase-get-record-with-names.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbase-get-record-with-names" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_get_record_with_names</refname>
  <refpurpose>
   Gets a record from a database as an associative array
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>dbase_get_record_with_names</methodname>
   <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>record_number</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets a record from a dBase database as an associative array.
  </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_number</parameter></term>
     <listitem>
      <para>
       The index of the record.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An associative array with the record. This will also include a key named 
   <literal>deleted</literal> which is set to 1 if the record has been marked
   for deletion (see <function>dbase_delete_record</function>).
  </para>
  <para>
   Each field is converted to the appropriate PHP type, except:
   <itemizedlist>
    <listitem>
     <simpara>
      Dates are left as strings.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Integers that would have caused an overflow (&gt; 32 bits)
      are returned as strings.
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   On error, <function>dbase_get_record_with_names</function> will return &false;.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Listing all the registered members in the database</title>
    <programlisting role="php">
<![CDATA[
<?php
// open in read-only mode
$db = dbase_open('/tmp/test.dbf', 0);

if ($db) {
  $record_numbers = dbase_numrecords($db);
  for ($i = 1; $i <= $record_numbers; $i++) {
      $row = dbase_get_record_with_names($db, $i);
      if ($row['ismember'] == 1) {
          echo "Member #$i: " . trim($row['name']) . "\n";
      }
  }
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dbase_get_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
-->