dbase-get-header-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.dbase-get-header-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_get_header_info</refname>
  <refpurpose>Получает информацию о свойствах полей базы данных</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>
   Возвращает информацию о структуре полей (столбцов) данного ресурса базы данных.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       Ресурс базы данных, полученный с помощью <function>dbase_open</function>
       или <function>dbase_create</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Индексированный массив значений для каждой колонки (поля).
   Индекс массива начинается с 0.
  </para>
  <para>
   Каждый элемент массива содержит ассоциативный массив информации о столбцах БД
   следующего вида:
   <variablelist>
    <varlistentry>
     <term>name</term>
     <listitem>
      <simpara>
       Наименование поля
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>type</term>
     <listitem>
      <simpara>
       Тип поля dBase в удобном для восприятия виде (date, boolean, и т.д.)
       Поддерживаемые типы файлов перечислены
       в <link linkend="intro.dbase">вводной секции</link>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>length</term>
     <listitem>
      <simpara>
       Максимально хранимое число байт данного поля (включая "precision" - прим. пер.)
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>precision</term>
     <listitem>
      <simpara>
       Количество цифр после запятой
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>format</term>
     <listitem>
      <simpara>
       Предложенный в <function>printf</function> формат спецификации для данного типа
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>offset</term>
     <listitem>
      <simpara>
       Байт смещения, указывающий размещение поля от начала записи (строки).
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   Если информация в заголовке базы данных не может быть прочитана, возвращает &false;.
  </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> теперь имеет тип
       <type>resource</type> а не <type>int</type>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Получение свойств полей файла базы данных dBase</title>
    <programlisting role="php">
<![CDATA[
<?php
// Путь к файлу БД
$db_path = "/tmp/test.dbf";

// Открываем файл БД
$dbh = dbase_open($db_path, 0)
  or die("Ошибка! Не получается открыть файл '$db_path'.");

// Получаем информацию о столбцах
$column_info = dbase_get_header_info($dbh);

// Отображение информации
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
-->