doc-fr/reference/dbase/functions/dbase-get-header-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: yannick -->

<refentry xml:id="function.dbase-get-header-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_get_header_info</refname>
  <refpurpose>Récupère des informations d'en-tête d'une base de données dBase</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>dbase_get_header_info</methodname>
   <methodparam><type>resource</type><parameter>database</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>dbase_get_header_info</function> retourne des informations sur
   la structure des colonnes de la base de données référencée par la ressource 
   <parameter>database</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       La ressource de base de données, retournée par 
       <function>dbase_open</function> ou <function>dbase_create</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un tableau indexé avec une entrée pour chaque colonne de la base de données.
   L'index du tableau commence à 0.
  </para>
  <para>
   Chaque élément du tableau contient un tableau associatif contenant les informations
   sur les colonnes, comme décrit ici :
   <variablelist>
    <varlistentry>
     <term>name</term>
     <listitem>
      <simpara>
       Le nom de la colonne
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>type</term>
     <listitem>
      <simpara>
       Le nom lisible du type de la colonne (i.e. date,
       boolean, etc.)
       Les types de champs supporté sont énumérés dans la
       <link linkend="intro.dbase">section d'introdcution</link>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>length</term>
     <listitem>
      <simpara>
       Le nombre d'octets que cette colonne peut contenir
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>precision</term>
     <listitem>
      <simpara>
       Le nombre de décimales pour la colonne
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>format</term>
     <listitem>
      <simpara>
       Un format <function>printf</function> suggéré pour la colonne
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>offset</term>
     <listitem>
      <simpara>
       La position de la colonne depuis la début de la ligne
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   Si les informations d'en-têtes de la base de données ne peuvent pas
   être lues, &false; est retourné.
  </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>database</parameter> est maintenant une <type>resource</type>
       au lieu d'un <type>int</type>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Affiche les informations d'en-têtes pour un fichier de base de données dBase</title>
    <programlisting role="php">
<![CDATA[
<?php
// Chemin vers le fichier dBase
$db_path = "/tmp/test.dbf";

// Ouvre le fichier dBase
$dbh = dbase_open($db_path, 0)
or die("Erreur ! Impossible d'ouvrir le fichier dBase '$db_path'.");

// Récupération des informations des colonnes
$column_info = dbase_get_header_info($dbh);

// Affichage des informations
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
-->