php-doc-en/reference/dbase/functions/dbase-get-header-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbase-get-header-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_get_header_info</refname>
  <refpurpose>Gets the header info of a database</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>dbase_get_header_info</methodname>
   <methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns information on the column structure of the given database link
   identifier.
  </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>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An indexed array with an entry for each column in the database. The array index
   starts at 0.
  </para>
  <para>
   Each array element contains an associative array of column information, as
   described here:
   <variablelist>
    <varlistentry>
     <term>name</term>
     <listitem>
      <simpara>
       The name of the column
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>type</term>
     <listitem>
      <simpara>
       The human-readable name for the dbase type of the column (i.e. date,
       boolean, etc.)
       The supported field types are listed in the <link
       linkend="intro.dbase">introduction section</link>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>length</term>
     <listitem>
      <simpara>
       The number of bytes this column can hold
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>precision</term>
     <listitem>
      <simpara>
       The number of digits of decimal precision for the column
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>format</term>
     <listitem>
      <simpara>
       A suggested <function>printf</function> format specifier for the column
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>offset</term>
     <listitem>
      <simpara>
       The byte offset of the column from the start of the row
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   If the database header information cannot be read, &false; is returned.
  </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>dbase_identifier</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>Showing header information for a dBase database file</title>
    <programlisting role="php">
<![CDATA[
<?php
// Path to dbase file
$db_path = "/tmp/test.dbf";

// Open dbase file
$dbh = dbase_open($db_path, 0)
  or die("Error! Could not open dbase database file '$db_path'.");

// Get column information
$column_info = dbase_get_header_info($dbh);

// Display information
print_r($column_info);
?>
]]>
    </programlisting>
   </example>
  </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
-->