didou Fri Jan 28 12:30:44 2005 EDT
Modified files:
/phpdoc/en/reference/dbase/functions dbase-close.xml
dbase-get-record-with-names.xml
dbase-get-record.xml
dbase-get-header-info.xml
Log:
Switch docs to the new structure
Also add see also, and reword a bit
# fix 31744
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-close.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/dbase/functions/dbase-close.xml
diff -u phpdoc/en/reference/dbase/functions/dbase-close.xml:1.2
phpdoc/en/reference/dbase/functions/dbase-close.xml:1.3
--- phpdoc/en/reference/dbase/functions/dbase-close.xml:1.2 Wed Apr 17
02:37:17 2002
+++ phpdoc/en/reference/dbase/functions/dbase-close.xml Fri Jan 28 12:30:43 2005
@@ -1,20 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.dbase-close">
<refnamediv>
<refname>dbase_close</refname>
<refpurpose>Close a dBase database</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_close</methodname>
<methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
</methodsynopsis>
<para>
- Closes the database associated with
- <parameter>dbase_identifier</parameter>.
+ Closes the given database link identifier.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dbase_identifier</parameter></term>
+ <listitem>
+ <para>
+ The dbase 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>
+ &return.success;
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dbase_open</function></member>
+ <member><function>dbase_create</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml
diff -u phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.2
phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.3
--- phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.2
Wed Apr 17 02:37:17 2002
+++ phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml Fri Jan
28 12:30:43 2005
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.dbase-get-record-with-names">
<refnamediv>
<refname>dbase_get_record_with_names</refname>
@@ -8,17 +7,46 @@
Gets a record from a dBase database as an associative array
</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <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</parameter></methodparam>
</methodsynopsis>
<para>
- Returns the data from <parameter>record</parameter> in an
- associative array. The array also includes an associative member
- named 'deleted' which is set to 1 if the record has been marked
+ 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 dbase link identifier, returned by <function>dbase_open</function>
+ or <function>dbase_create</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>record</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>
@@ -26,17 +54,28 @@
<itemizedlist>
<listitem>
<simpara>
- Dates are left as strings
+ Dates are left as strings.
</simpara>
</listitem>
<listitem>
<simpara>
Integers that would have caused an overflow (> 32 bits)
- are returned as strings
+ 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="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dbase_get_record</function></member>
+ </simplelist>
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-get-record.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/dbase/functions/dbase-get-record.xml
diff -u phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.2
phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.3
--- phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.2 Wed Apr
17 02:37:17 2002
+++ phpdoc/en/reference/dbase/functions/dbase-get-record.xml Fri Jan 28
12:30:43 2005
@@ -1,41 +1,81 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.dbase-get-record">
<refnamediv>
<refname>dbase_get_record</refname>
- <refpurpose>Gets a record from a dBase database</refpurpose>
+ <refpurpose>
+ Gets a record from a dBase database as an indexed array
+ </refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dbase_get_record</methodname>
<methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>record</parameter></methodparam>
</methodsynopsis>
<para>
- Returns the data from <parameter>record</parameter> in an
- array. The array is indexed starting at 0, and includes an
- associative member named 'deleted' which is set to 1 if the
- record has been marked for deletion (see
- <function>dbase_delete_record</function>.
+ Gets a record from a dBase database as an indexed array.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dbase_identifier</parameter></term>
+ <listitem>
+ <para>
+ The dbase link identifier, returned by <function>dbase_open</function>
+ or <function>dbase_create</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>record</parameter></term>
+ <listitem>
+ <para>
+ The index of the record.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An indexed array with the record. This array will also include an
associative
+ 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
+ Dates are left as strings.
</simpara>
</listitem>
<listitem>
<simpara>
Integers that would have caused an overflow (> 32 bits)
- are returned as strings
+ are returned as strings.
</simpara>
</listitem>
</itemizedlist>
</para>
+ <para>
+ On error, <function>dbase_get_record</function> will return &false;
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dbase_get_record_with_names</function></member>
+ </simplelist>
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml
diff -u phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml:1.3
phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml:1.4
--- phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml:1.3 Wed Nov
26 07:52:17 2003
+++ phpdoc/en/reference/dbase/functions/dbase-get-header-info.xml Fri Jan
28 12:30:43 2005
@@ -1,42 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.dbase-get-header-info">
<refnamediv>
<refname>dbase_get_header_info</refname>
<refpurpose>Get the header info of a dBase database</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dbase_get_header_info</methodname>
<methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
</methodsynopsis>
<para>
- Returns information on the column structure of the database referenced by
- <parameter>dbase_identifier</parameter>. For each column in the database,
- there is an entry in a numerically-indexed array. The array index starts
- at 0. Each array element contains an associative array of column
- information. If the database header information cannot be read, &false;
- is returned.
+ Returns information on the column structure of the given database link
+ identifier.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- The array elements are:
<variablelist>
<varlistentry>
- <term>
- name
- </term>
+ <term><parameter>dbase_identifier</parameter></term>
+ <listitem>
+ <para>
+ The dbase 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>
+ <term>type</term>
<listitem>
<simpara>
The human-readable name for the dbase type of the column (i.e. date,
@@ -44,44 +59,32 @@
</simpara>
</listitem>
</varlistentry>
-
<varlistentry>
- <term>
- length
- </term>
+ <term>length</term>
<listitem>
<simpara>
The number of bytes this column can hold
</simpara>
</listitem>
</varlistentry>
-
<varlistentry>
- <term>
- precision
- </term>
+ <term>precision</term>
<listitem>
<simpara>
The number of digits of decimal precision for the column
</simpara>
</listitem>
</varlistentry>
-
<varlistentry>
- <term>
- format
- </term>
+ <term>format</term>
<listitem>
<simpara>
A suggested <function>printf</function> format specifier for the
column
</simpara>
</listitem>
</varlistentry>
-
<varlistentry>
- <term>
- offset
- </term>
+ <term>offset</term>
<listitem>
<simpara>
The byte offset of the column from the start of the row
@@ -91,6 +94,12 @@
</variablelist>
</para>
<para>
+ If the database header information cannot be read, &false; is returned.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
<example>
<title>Showing header information for a dBase database file</title>
<programlisting role="php">
@@ -113,7 +122,6 @@
</programlisting>
</example>
</para>
-
</refsect1>
</refentry>
