1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?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>database</parameter></methodparam>
</methodsynopsis>
<para>
Returns information on the column structure of the given database resource.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database resource, 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>PECL dbase 7.0.0</entry>
<entry>
<parameter>database</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
-->
|
