Update dbase parameter names

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350685 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2020-09-27 13:25:27 +00:00
parent e443388d42
commit ca47781c2d
12 changed files with 69 additions and 63 deletions

View file

@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_add_record</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>array</type><parameter>record</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
<methodparam><type>array</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Adds the given data to the database.
@ -21,16 +21,16 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record</parameter></term>
<term><parameter>data</parameter></term>
<listitem>
<para>
An indexed array of data. The number of items must be equal to the number of
@ -69,7 +69,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,10 +9,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_close</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
Closes the given database link identifier.
Closes the given database resource.
</para>
</refsect1>
<refsect1 role="parameters">
@ -20,10 +20,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
@ -52,7 +52,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>dbase_create</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>array</type><parameter>fields</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>DBASE_TYPE_DBASE</initializer></methodparam>
</methodsynopsis>
@ -27,10 +27,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>path</parameter></term>
<listitem>
<para>
The name of the database. It can be a relative or absolute path to
The path of the database. It can be a relative or absolute path to
the file where dBase will store your data.
</para>
</listitem>
@ -68,7 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a database link identifier if the database is successfully created,
Returns a database resource if the database is successfully created,
or &false; if an error occurred.
</para>
</refsect1>

View file

@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_delete_record</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>record_number</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Marks the given record to be deleted from the database.
@ -27,16 +27,16 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record_number</parameter></term>
<term><parameter>number</parameter></term>
<listitem>
<para>
An integer which spans from 1 to the number of records in the database
@ -68,7 +68,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,11 +9,10 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dbase_get_header_info</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
Returns information on the column structure of the given database link
identifier.
Returns information on the column structure of the given database resource.
</para>
</refsect1>
<refsect1 role="parameters">
@ -21,10 +20,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
@ -114,7 +113,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dbase_get_record_with_names</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>record_number</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Gets a record from a dBase database as an associative array.
@ -23,16 +23,16 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record_number</parameter></term>
<term><parameter>_number</parameter></term>
<listitem>
<para>
The index of the record between <literal>1</literal> and
@ -72,7 +72,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>dbase_get_record</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>record_number</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Gets a record from a database as an indexed array.
@ -23,16 +23,16 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record_number</parameter></term>
<term><parameter>number</parameter></term>
<listitem>
<para>
The index of the record between <literal>1</literal> and
@ -70,7 +70,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>dbase_numfields</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
Gets the number of fields (columns) in the specified database.
@ -26,10 +26,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
@ -58,7 +58,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>dbase_numrecords</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
Gets the number of records (rows) in the specified database.
@ -31,10 +31,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
@ -63,7 +63,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>dbase_open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
@ -24,10 +24,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>path</parameter></term>
<listitem>
<para>
The name of the database. It can be a relative or absolute path to
The path of the database. It can be a relative or absolute path to
the file where dBase will store your data.
</para>
</listitem>
@ -58,6 +58,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a database resource on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
@ -108,7 +115,7 @@ if ($db) {
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a database link identifier if the database is successfully opened,
Returns a database resource if the database is successfully opened,
or &false; if an error occurred.
</para>
</refsect1>

View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_pack</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
Packs the specified database by permanently deleting all records marked
@ -23,10 +23,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
@ -55,7 +55,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>

View file

@ -9,9 +9,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dbase_replace_record</methodname>
<methodparam><type>resource</type><parameter>dbase_identifier</parameter></methodparam>
<methodparam><type>array</type><parameter>record</parameter></methodparam>
<methodparam><type>int</type><parameter>record_number</parameter></methodparam>
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
<methodparam><type>array</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Replaces the given record in the database with the given data.
@ -22,16 +22,16 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dbase_identifier</parameter></term>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database link identifier, returned by <function>dbase_open</function>
The database resource, returned by <function>dbase_open</function>
or <function>dbase_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record</parameter></term>
<term><parameter>data</parameter></term>
<listitem>
<para>
An indexed array of data. The number of items must be equal to the
@ -47,7 +47,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record_number</parameter></term>
<term><parameter>number</parameter></term>
<listitem>
<para>
An integer which spans from 1 to the number of records in the database
@ -79,7 +79,7 @@
<row>
<entry>dbase 7.0.0</entry>
<entry>
<parameter>dbase_identifier</parameter> is now a <type>resource</type>
<parameter>database</parameter> is now a <type>resource</type>
instead of an <type>int</type>.
</entry>
</row>