cvs: phpdoc /en/reference/dbase/functions dbase-add-record.xml dbase-create.xml dbase-delete-record.xml dbase-get-record-with-names.xml
dbase-get-record.xml dbase-numfields.xml dbase-numrecords.xml dbase-open.xml dbase-pack.xml dbase-replace-record.xml
| From: | Mehdi Achour | Date: | Sat, 29 Jan 2005 17:18:52 +0000 |
| Subject: | cvs: phpdoc /en/reference/dbase/functions dbase-add-record.xml dbase-create.xml dbase-delete-record.xml dbase-get-record-with-names.xml dbase-get-record.xml dbase-numfields.xml dbase-numrecords.xml dbase-open.xml dbase-pack.xml dbase-replace-record.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969366241@lists.php.net to get a copy of this message | ||
didou Sat Jan 29 12:18:52 2005 EDT
Modified files:
/phpdoc/en/reference/dbase/functions dbase-add-record.xml
dbase-create.xml
dbase-delete-record.xml
dbase-get-record-with-names.xml
dbase-get-record.xml
dbase-numfields.xml
dbase-numrecords.xml
dbase-open.xml dbase-pack.xml
dbase-replace-record.xml
Log:
Switch the rest of function to the new structure,
Add see also, notes and pitfalls
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-add-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-add-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.2 Wed Apr 17 02:37:16 2002 +++ phpdoc/en/reference/dbase/functions/dbase-add-record.xml Sat Jan 29 12:18:51 2005 @@ -1,23 +1,66 @@ <?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-add-record"> <refnamediv> <refname>dbase_add_record</refname> <refpurpose>Add a record to a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_add_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> </methodsynopsis> <para> - Adds the data in the <parameter>record</parameter> to the - database. If the number of items in the supplied record isn't - equal to the number of fields in the database, the operation will - fail and &false; will be returned. + Adds the given data to the database. + </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> + An indexed array of data. The number of items must be equal to the number of + fields in the database, otherwise <function>dbase_add_record</function> + will fail. + </para> + <note> + <para> + If you're using <function>dbase_get_record</function> return value for this + parameter, remember to reset the key named <literal>deleted</literal>. + </para> + </note> + </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_delete_record</function></member> + <member><function>dbase_replace_record</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-create.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-create.xml diff -u phpdoc/en/reference/dbase/functions/dbase-create.xml:1.6 phpdoc/en/reference/dbase/functions/dbase-create.xml:1.7 --- phpdoc/en/reference/dbase/functions/dbase-create.xml:1.6 Sun Feb 8 14:21:34 2004 +++ phpdoc/en/reference/dbase/functions/dbase-create.xml Sat Jan 29 12:18:51 2005 @@ -1,86 +1,115 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.dbase-create"> <refnamediv> <refname>dbase_create</refname> <refpurpose>Creates a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_create</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>array</type><parameter>fields</parameter></methodparam> </methodsynopsis> - <para> - <function>dbase_create</function> creates a dBase database - in the file <parameter>filename</parameter>, - with the fields <parameter>fields</parameter>. - </para> <para> - The <parameter>fields</parameter> parameter is an array of - arrays, each array describing the format of one field in the - database. Each field consists of a name, a character indicating - the field type, a length, and a precision. + <function>dbase_create</function> creates a dBase database with the given + definition. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The types of fields available are: <variablelist> <varlistentry> - <term>L</term> - <listitem> - <simpara> - Boolean. These do not have a length or precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>M</term> - <listitem> - <simpara> - Memo. (Note that these aren't supported by PHP.) These do - not have a length or precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>D</term> - <listitem> - <simpara> - Date (stored as YYYYMMDD). These do not have a length or - precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>N</term> + <term><parameter>filename</parameter></term> <listitem> - <simpara> - Number. These have both a length and a precision (the number - of digits after the decimal point). - </simpara> + <para> + The name of the database. It can be a relative or absolute path to + the file where dBase will store your data. + </para> </listitem> </varlistentry> <varlistentry> - <term>C</term> + <term><parameter>fields</parameter></term> <listitem> - <simpara> - String. - </simpara> + <para> + An array of arrays, each array describing the format of one field of the + database. Each field consists of a name, a character indicating the field + type, a length, and a precision. + </para> + <note> + <para> + The fieldnames are limited in length and must not exceed 10 chars, + </para> + </note> + <para> + The types of fields available are: + <variablelist> + <varlistentry> + <term>L</term> + <listitem> + <para> + Boolean. These do not have a length or precision. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para> + Memo. These do not have a length or precision. + </para> + <note> + <para> + This type is not supported by PHP. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>D</term> + <listitem> + <para> + Date (stored as <literal>YYYYMMDD</literal>). These do not have a + length or precision. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>N</term> + <listitem> + <para> + Number. These have both a length and a precision (the number + of digits after the decimal point). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>C</term> + <listitem> + <para> + String. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </listitem> </varlistentry> </variablelist> </para> - <note> - <para> - The fieldnames are limited in length and must not exceed 10 chars, - 0 < chars <= 10. - </para> - </note> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a database link identifier if the database is successfully created, + or &false; if an error occured. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - If the database is successfully created, a dbase_identifier is - returned, otherwise &false; is returned. <example> <title>Creating a dBase database file</title> <programlisting role="php"> @@ -91,18 +120,18 @@ $dbname = "/tmp/test.dbf"; // database "definition" -$def = - array( +$def = array( array("date", "D"), array("name", "C", 50), array("age", "N", 3, 0), array("email", "C", 128), array("ismember", "L") - ); +); // creation -if (!dbase_create($dbname, $def)) - echo "<strong>Error!</strong>"; +if (!dbase_create($dbname, $def)) { + echo "Error, can't create $dbname"; +} ?> ]]> @@ -110,6 +139,15 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_open</function></member> + <member><function>dbase_close</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-delete-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-delete-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.2 Wed Apr 17 02:37:17 2002 +++ phpdoc/en/reference/dbase/functions/dbase-delete-record.xml Sat Jan 29 12:18:51 2005 @@ -1,22 +1,65 @@ <?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-delete-record"> <refnamediv> <refname>dbase_delete_record</refname> <refpurpose>Deletes a record from a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_delete_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>record</parameter></methodparam> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> - Marks <parameter>record</parameter> to be deleted from the - database. To actually remove the record from the database, you - must also call <function>dbase_pack</function>. + Marks the given record to be deleted from the database. + </para> + <note> + <para> + To actually remove the record from the database, you must also call + <function>dbase_pack</function>. + </para> + </note> + </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_number</parameter></term> + <listitem> + <para> + An integer which spans from 1 to the number of records in the database + (as returned by <function>dbase_numrecords</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_add_record</function></member> + <member><function>dbase_replace_record</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.3&r2=1.4&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.3 phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.4 --- phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.3 Fri Jan 28 12:30:43 2005 +++ phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml Sat Jan 29 12:18:51 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbase-get-record-with-names"> <refnamediv> <refname>dbase_get_record_with_names</refname> @@ -12,7 +12,7 @@ <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> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> Gets a record from a dBase database as an associative array. @@ -32,7 +32,7 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>record</parameter></term> + <term><parameter>record_number</parameter></term> <listitem> <para> The index of the record. http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-get-record.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-get-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.3 phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.4 --- phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.3 Fri Jan 28 12:30:43 2005 +++ phpdoc/en/reference/dbase/functions/dbase-get-record.xml Sat Jan 29 12:18:51 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbase-get-record"> <refnamediv> <refname>dbase_get_record</refname> @@ -12,7 +12,7 @@ <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> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> Gets a record from a dBase database as an indexed array. @@ -32,7 +32,7 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>record</parameter></term> + <term><parameter>record_number</parameter></term> <listitem> <para> The index of the record. http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-numfields.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-numfields.xml diff -u phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.4 phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.5 --- phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.4 Mon Dec 15 11:48:47 2003 +++ phpdoc/en/reference/dbase/functions/dbase-numfields.xml Sat Jan 29 12:18:51 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbase-numfields"> <refnamediv> <refname>dbase_numfields</refname> @@ -8,26 +7,57 @@ Find out how many fields are in a dBase database </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_numfields</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the number of fields (columns) in the specified - database. Field numbers are between 0 and dbase_numfields($db)-1, - while record numbers are between 1 and dbase_numrecords($db). + Gets the number of fields (columns) in the specified database. + </para> + <note> + <para> + Field numbers are between 0 and dbase_numfields($db)-1, + while record numbers are between 1 and dbase_numrecords($db). + </para> + </note> + </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> + The number of fields in the database, or &false; if an error occurs. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> - <title>Using <function>dbase_numfields</function></title> + <title><function>dbase_numfields</function> Example</title> <programlisting role="php"> <![CDATA[ <?php $rec = dbase_get_record($db, $recno); $nf = dbase_numfields($db); -for ($i=0; $i < $nf; $i++) { - echo $rec[$i]."<br />\n"; +for ($i = 0; $i < $nf; $i++) { + echo $rec[$i], "\n"; } ?> @@ -36,6 +66,14 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_numrecords</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-numrecords.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-numrecords.xml diff -u phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-numrecords.xml Sat Jan 29 12:18:51 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-numrecords"> <refnamediv> <refname>dbase_numrecords</refname> @@ -8,16 +7,50 @@ Find out how many records are in a dBase database </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_numrecords</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the number of records (rows) in the specified - database. Record numbers are between 1 and dbase_numrecords($db), - while field numbers are between 0 and dbase_numfields($db)-1. + Gets the number of records (rows) in the specified database. + </para> + <note> + <para> + Record numbers are between 1 and dbase_numrecords($db), + while field numbers are between 0 and dbase_numfields($db)-1. + </para> + </note> + </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> + The number of records in the database, or &false; if an error occurs. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_num_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-open.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-open.xml diff -u phpdoc/en/reference/dbase/functions/dbase-open.xml:1.4 phpdoc/en/reference/dbase/functions/dbase-open.xml:1.5 --- phpdoc/en/reference/dbase/functions/dbase-open.xml:1.4 Mon Feb 10 22:10:58 2003 +++ phpdoc/en/reference/dbase/functions/dbase-open.xml Sat Jan 29 12:18:51 2005 @@ -1,28 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbase-open"> <refnamediv> <refname>dbase_open</refname> <refpurpose>Opens a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> + <para> + <function>dbase_open</function> opens a dBase database with the given + access mode. + </para> + ¬e.sm.uidcheck; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The name of the database. It can be a relative or absolute path to + the file where dBase will store your data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + An integer which correspond to those for the <command>open()</command> + system call (Typically 0 means read-only, 1 means write-only, and 2 means + read and write). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Returns a dbase_identifier for the opened database, or &false; if - the database couldn't be opened. + Returns a database link identifier if the database is successfully opened, + or &false; if an error occured. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Parameter <parameter>flags</parameter> correspond to those - for the open() system call (Typically 0 means read-only, 1 means - write-only, and 2 means read and write). + <simplelist> + <member><function>dbase_create</function></member> + <member><function>dbase_close</function></member> + </simplelist> </para> - ¬e.sm.uidcheck; </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-pack.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-pack.xml diff -u phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-pack.xml Sat Jan 29 12:18:51 2005 @@ -1,21 +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-pack"> <refnamediv> <refname>dbase_pack</refname> <refpurpose>Packs a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_pack</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Packs the specified database (permanently deleting all records - marked for deletion using - <function>dbase_delete_record</function>). + Packs the specified database by permanently deleting all records marked + for deletion using <function>dbase_delete_record</function>. + </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_delete_record</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-replace-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-replace-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-replace-record.xml Sat Jan 29 12:18:51 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-replace-record"> <refnamediv> <refname>dbase_replace_record</refname> @@ -12,21 +11,67 @@ <type>bool</type><methodname>dbase_replace_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> - <methodparam><type>int</type><parameter>dbase_record_number</parameter></methodparam> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> - <simpara> - Replaces the data associated with the record - <parameter>record_number</parameter> with the data in the - <parameter>record</parameter> in the database. If the number of - items in the supplied record is not equal to the number of fields - in the database, the operation will fail and &false; will be - returned. - </simpara> - <simpara> - <parameter>dbase_record_number</parameter> is an integer which - spans from 1 to the number of records in the database (as - returned by <function>dbase_numrecords</function>). - </simpara> + <para> + Replaces the given record in the database with the given data. + </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> + An indexed array of data. The number of items must be equal to the number of + fields in the database, otherwise <function>dbase_add_record</function> + will fail. + </para> + <note> + <para> + If you're using <function>dbase_get_record</function> return value for this + parameter, remember to reset the key named <literal>deleted</literal>. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>record_number</parameter></term> + <listitem> + <para> + An integer which spans from 1 to the number of records in the database + (as returned by <function>dbase_numrecords</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_add_record</function></member> + <member><function>dbase_delete_record</function></member> + </simplelist> + </para> </refsect1> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-add-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-add-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-add-record.xml:1.2 Wed Apr 17 02:37:16 2002 +++ phpdoc/en/reference/dbase/functions/dbase-add-record.xml Sat Jan 29 12:18:51 2005 @@ -1,23 +1,66 @@ <?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-add-record"> <refnamediv> <refname>dbase_add_record</refname> <refpurpose>Add a record to a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_add_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> </methodsynopsis> <para> - Adds the data in the <parameter>record</parameter> to the - database. If the number of items in the supplied record isn't - equal to the number of fields in the database, the operation will - fail and &false; will be returned. + Adds the given data to the database. + </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> + An indexed array of data. The number of items must be equal to the number of + fields in the database, otherwise <function>dbase_add_record</function> + will fail. + </para> + <note> + <para> + If you're using <function>dbase_get_record</function> return value for this + parameter, remember to reset the key named <literal>deleted</literal>. + </para> + </note> + </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_delete_record</function></member> + <member><function>dbase_replace_record</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-create.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-create.xml diff -u phpdoc/en/reference/dbase/functions/dbase-create.xml:1.6 phpdoc/en/reference/dbase/functions/dbase-create.xml:1.7 --- phpdoc/en/reference/dbase/functions/dbase-create.xml:1.6 Sun Feb 8 14:21:34 2004 +++ phpdoc/en/reference/dbase/functions/dbase-create.xml Sat Jan 29 12:18:51 2005 @@ -1,86 +1,115 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.dbase-create"> <refnamediv> <refname>dbase_create</refname> <refpurpose>Creates a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_create</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>array</type><parameter>fields</parameter></methodparam> </methodsynopsis> - <para> - <function>dbase_create</function> creates a dBase database - in the file <parameter>filename</parameter>, - with the fields <parameter>fields</parameter>. - </para> <para> - The <parameter>fields</parameter> parameter is an array of - arrays, each array describing the format of one field in the - database. Each field consists of a name, a character indicating - the field type, a length, and a precision. + <function>dbase_create</function> creates a dBase database with the given + definition. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The types of fields available are: <variablelist> <varlistentry> - <term>L</term> - <listitem> - <simpara> - Boolean. These do not have a length or precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>M</term> - <listitem> - <simpara> - Memo. (Note that these aren't supported by PHP.) These do - not have a length or precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>D</term> - <listitem> - <simpara> - Date (stored as YYYYMMDD). These do not have a length or - precision. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term>N</term> + <term><parameter>filename</parameter></term> <listitem> - <simpara> - Number. These have both a length and a precision (the number - of digits after the decimal point). - </simpara> + <para> + The name of the database. It can be a relative or absolute path to + the file where dBase will store your data. + </para> </listitem> </varlistentry> <varlistentry> - <term>C</term> + <term><parameter>fields</parameter></term> <listitem> - <simpara> - String. - </simpara> + <para> + An array of arrays, each array describing the format of one field of the + database. Each field consists of a name, a character indicating the field + type, a length, and a precision. + </para> + <note> + <para> + The fieldnames are limited in length and must not exceed 10 chars, + </para> + </note> + <para> + The types of fields available are: + <variablelist> + <varlistentry> + <term>L</term> + <listitem> + <para> + Boolean. These do not have a length or precision. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para> + Memo. These do not have a length or precision. + </para> + <note> + <para> + This type is not supported by PHP. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>D</term> + <listitem> + <para> + Date (stored as <literal>YYYYMMDD</literal>). These do not have a + length or precision. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>N</term> + <listitem> + <para> + Number. These have both a length and a precision (the number + of digits after the decimal point). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>C</term> + <listitem> + <para> + String. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </listitem> </varlistentry> </variablelist> </para> - <note> - <para> - The fieldnames are limited in length and must not exceed 10 chars, - 0 < chars <= 10. - </para> - </note> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a database link identifier if the database is successfully created, + or &false; if an error occured. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - If the database is successfully created, a dbase_identifier is - returned, otherwise &false; is returned. <example> <title>Creating a dBase database file</title> <programlisting role="php"> @@ -91,18 +120,18 @@ $dbname = "/tmp/test.dbf"; // database "definition" -$def = - array( +$def = array( array("date", "D"), array("name", "C", 50), array("age", "N", 3, 0), array("email", "C", 128), array("ismember", "L") - ); +); // creation -if (!dbase_create($dbname, $def)) - echo "<strong>Error!</strong>"; +if (!dbase_create($dbname, $def)) { + echo "Error, can't create $dbname"; +} ?> ]]> @@ -110,6 +139,15 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_open</function></member> + <member><function>dbase_close</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-delete-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-delete-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-delete-record.xml:1.2 Wed Apr 17 02:37:17 2002 +++ phpdoc/en/reference/dbase/functions/dbase-delete-record.xml Sat Jan 29 12:18:51 2005 @@ -1,22 +1,65 @@ <?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-delete-record"> <refnamediv> <refname>dbase_delete_record</refname> <refpurpose>Deletes a record from a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_delete_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>record</parameter></methodparam> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> - Marks <parameter>record</parameter> to be deleted from the - database. To actually remove the record from the database, you - must also call <function>dbase_pack</function>. + Marks the given record to be deleted from the database. + </para> + <note> + <para> + To actually remove the record from the database, you must also call + <function>dbase_pack</function>. + </para> + </note> + </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_number</parameter></term> + <listitem> + <para> + An integer which spans from 1 to the number of records in the database + (as returned by <function>dbase_numrecords</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_add_record</function></member> + <member><function>dbase_replace_record</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.3&r2=1.4&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.3 phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.4 --- phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml:1.3 Fri Jan 28 12:30:43 2005 +++ phpdoc/en/reference/dbase/functions/dbase-get-record-with-names.xml Sat Jan 29 12:18:51 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbase-get-record-with-names"> <refnamediv> <refname>dbase_get_record_with_names</refname> @@ -12,7 +12,7 @@ <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> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> Gets a record from a dBase database as an associative array. @@ -32,7 +32,7 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>record</parameter></term> + <term><parameter>record_number</parameter></term> <listitem> <para> The index of the record. http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-get-record.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-get-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.3 phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.4 --- phpdoc/en/reference/dbase/functions/dbase-get-record.xml:1.3 Fri Jan 28 12:30:43 2005 +++ phpdoc/en/reference/dbase/functions/dbase-get-record.xml Sat Jan 29 12:18:51 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbase-get-record"> <refnamediv> <refname>dbase_get_record</refname> @@ -12,7 +12,7 @@ <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> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> <para> Gets a record from a dBase database as an indexed array. @@ -32,7 +32,7 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>record</parameter></term> + <term><parameter>record_number</parameter></term> <listitem> <para> The index of the record. http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-numfields.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-numfields.xml diff -u phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.4 phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.5 --- phpdoc/en/reference/dbase/functions/dbase-numfields.xml:1.4 Mon Dec 15 11:48:47 2003 +++ phpdoc/en/reference/dbase/functions/dbase-numfields.xml Sat Jan 29 12:18:51 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbase-numfields"> <refnamediv> <refname>dbase_numfields</refname> @@ -8,26 +7,57 @@ Find out how many fields are in a dBase database </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_numfields</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the number of fields (columns) in the specified - database. Field numbers are between 0 and dbase_numfields($db)-1, - while record numbers are between 1 and dbase_numrecords($db). + Gets the number of fields (columns) in the specified database. + </para> + <note> + <para> + Field numbers are between 0 and dbase_numfields($db)-1, + while record numbers are between 1 and dbase_numrecords($db). + </para> + </note> + </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> + The number of fields in the database, or &false; if an error occurs. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> - <title>Using <function>dbase_numfields</function></title> + <title><function>dbase_numfields</function> Example</title> <programlisting role="php"> <![CDATA[ <?php $rec = dbase_get_record($db, $recno); $nf = dbase_numfields($db); -for ($i=0; $i < $nf; $i++) { - echo $rec[$i]."<br />\n"; +for ($i = 0; $i < $nf; $i++) { + echo $rec[$i], "\n"; } ?> @@ -36,6 +66,14 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_numrecords</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-numrecords.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-numrecords.xml diff -u phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-numrecords.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-numrecords.xml Sat Jan 29 12:18:51 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-numrecords"> <refnamediv> <refname>dbase_numrecords</refname> @@ -8,16 +7,50 @@ Find out how many records are in a dBase database </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_numrecords</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the number of records (rows) in the specified - database. Record numbers are between 1 and dbase_numrecords($db), - while field numbers are between 0 and dbase_numfields($db)-1. + Gets the number of records (rows) in the specified database. + </para> + <note> + <para> + Record numbers are between 1 and dbase_numrecords($db), + while field numbers are between 0 and dbase_numfields($db)-1. + </para> + </note> + </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> + The number of records in the database, or &false; if an error occurs. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbase_num_fields</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-open.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-open.xml diff -u phpdoc/en/reference/dbase/functions/dbase-open.xml:1.4 phpdoc/en/reference/dbase/functions/dbase-open.xml:1.5 --- phpdoc/en/reference/dbase/functions/dbase-open.xml:1.4 Mon Feb 10 22:10:58 2003 +++ phpdoc/en/reference/dbase/functions/dbase-open.xml Sat Jan 29 12:18:51 2005 @@ -1,28 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbase.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbase-open"> <refnamediv> <refname>dbase_open</refname> <refpurpose>Opens a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbase_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> + <para> + <function>dbase_open</function> opens a dBase database with the given + access mode. + </para> + ¬e.sm.uidcheck; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The name of the database. It can be a relative or absolute path to + the file where dBase will store your data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + An integer which correspond to those for the <command>open()</command> + system call (Typically 0 means read-only, 1 means write-only, and 2 means + read and write). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Returns a dbase_identifier for the opened database, or &false; if - the database couldn't be opened. + Returns a database link identifier if the database is successfully opened, + or &false; if an error occured. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Parameter <parameter>flags</parameter> correspond to those - for the open() system call (Typically 0 means read-only, 1 means - write-only, and 2 means read and write). + <simplelist> + <member><function>dbase_create</function></member> + <member><function>dbase_close</function></member> + </simplelist> </para> - ¬e.sm.uidcheck; </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-pack.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-pack.xml diff -u phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-pack.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-pack.xml Sat Jan 29 12:18:51 2005 @@ -1,21 +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-pack"> <refnamediv> <refname>dbase_pack</refname> <refpurpose>Packs a dBase database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>dbase_pack</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> </methodsynopsis> <para> - Packs the specified database (permanently deleting all records - marked for deletion using - <function>dbase_delete_record</function>). + Packs the specified database by permanently deleting all records marked + for deletion using <function>dbase_delete_record</function>. + </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_delete_record</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/dbase/functions/dbase-replace-record.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/dbase/functions/dbase-replace-record.xml diff -u phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.2 phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.3 --- phpdoc/en/reference/dbase/functions/dbase-replace-record.xml:1.2 Wed Apr 17 02:37:18 2002 +++ phpdoc/en/reference/dbase/functions/dbase-replace-record.xml Sat Jan 29 12:18:51 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-replace-record"> <refnamediv> <refname>dbase_replace_record</refname> @@ -12,21 +11,67 @@ <type>bool</type><methodname>dbase_replace_record</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> - <methodparam><type>int</type><parameter>dbase_record_number</parameter></methodparam> + <methodparam><type>int</type><parameter>record_number</parameter></methodparam> </methodsynopsis> - <simpara> - Replaces the data associated with the record - <parameter>record_number</parameter> with the data in the - <parameter>record</parameter> in the database. If the number of - items in the supplied record is not equal to the number of fields - in the database, the operation will fail and &false; will be - returned. - </simpara> - <simpara> - <parameter>dbase_record_number</parameter> is an integer which - spans from 1 to the number of records in the database (as - returned by <function>dbase_numrecords</function>). - </simpara> + <para> + Replaces the given record in the database with the given data. + </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> + An indexed array of data. The number of items must be equal to the number of + fields in the database, otherwise <function>dbase_add_record</function> + will fail. + </para> + <note> + <para> + If you're using <function>dbase_get_record</function> return value for this + parameter, remember to reset the key named <literal>deleted</literal>. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>record_number</parameter></term> + <listitem> + <para> + An integer which spans from 1 to the number of records in the database + (as returned by <function>dbase_numrecords</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_add_record</function></member> + <member><function>dbase_delete_record</function></member> + </simplelist> + </para> </refsect1> </refentry>