dams Thu May 10 01:20:37 2001 EDT
Modified files:
/phpdoc/en/functions fbsql.xml
Log:
used resources whenever possible.Some minor reformating
Index: phpdoc/en/functions/fbsql.xml
diff -u phpdoc/en/functions/fbsql.xml:1.4 phpdoc/en/functions/fbsql.xml:1.5
--- phpdoc/en/functions/fbsql.xml:1.4 Wed May 9 11:53:07 2001
+++ phpdoc/en/functions/fbsql.xml Thu May 10 01:20:37 2001
@@ -92,11 +92,11 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>fbsql_autocommit</function></funcdef>
- <paramdef>int
+ <funcdef>boolean <function>fbsql_autocommit</function></funcdef>
+ <paramdef>resource
<parameter>link_identifier</parameter>
</paramdef>
- <paramdef>bool
+ <paramdef>boolean
<parameter>
<optional>OnOff</optional>
</parameter>
@@ -142,7 +142,8 @@
optional parameter link_identifier. If a database is
specified, this will default or current database after the user
has been changed. If the new user and password authorization fails,
- the current connected user stays active.</para>
+ the current connected user stays active.
+ </para>
</refsect1>
</refentry>
@@ -156,7 +157,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>fbsql_close</function></funcdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -259,7 +260,8 @@
?>
</programlisting>
</example>
- <para> See also
+ <para>
+ See also
<function>fbsql_pconnect</function>, and
<function>fbsql_close</function>.
</para>
@@ -275,9 +277,9 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_create_db</function></funcdef>
+ <funcdef>boolean <function>fbsql_create_db</function></funcdef>
<paramdef>string <parameter>database name</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -296,9 +298,9 @@
$link = fbsql_pconnect ("localhost", "_SYSTEM", "secret")
or die ("Could not connect");
if (fbsql_create_db ("my_db")) {
- print ("Database created successfully\n");
+ print("Database created successfully\n");
} else {
- printf ("Error creating database: %s\n", fbsql_error ());
+ printf("Error creating database: %s\n", fbsql_error ());
}
?>
</programlisting>
@@ -319,7 +321,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>fbsql_data_seek</function></funcdef>
- <paramdef>int <parameter>result_identifier</parameter></paramdef>
+ <paramdef>resource <parameter>result_identifier</parameter></paramdef>
<paramdef>int <parameter>row_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -361,7 +363,7 @@
if(!($row = fbsql_fetch_object ($result)))
continue;
- printf ("%s %s<BR>\n", $row->last_name, $row->first_name);
+ printf("%s %s<BR>\n", $row->last_name, $row->first_name);
}
fbsql_free_result ($result);
@@ -383,7 +385,7 @@
<funcdef>resource <function>fbsql_db_query</function></funcdef>
<paramdef>string <parameter>database</parameter></paramdef>
<paramdef>string <parameter>query</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -419,7 +421,7 @@
<funcprototype>
<funcdef>boolean <function>fbsql_drop_db</function></funcdef>
<paramdef>string <parameter>database_name</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -448,7 +450,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_errno</function></funcdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -499,7 +501,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_error</function></funcdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -550,7 +552,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>array <function>fbsql_fetch_array</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int
<parameter>
<optional>result_type</optional>
@@ -625,7 +627,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>array <function>fbsql_fetch_assoc</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -684,7 +686,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>object <function>fbsql_fetch_field</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int
<parameter>
<optional>field_offset</optional>
@@ -778,10 +780,8 @@
<funcsynopsis>
<funcprototype>
<funcdef>array <function>fbsql_fetch_lengths</function></funcdef>
- <paramdef>int
- <parameter>
- <optional>result</optional>
- </parameter>
+ <paramdef>resource
+ <parameter><optional>result</optional></parameter>
</funcprototype>
</funcsynopsis>
<para>
@@ -813,7 +813,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>object <function>fbsql_fetch_object</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int
<parameter>
<optional>result_type</optional>
@@ -874,7 +874,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>array <function>fbsql_fetch_row</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -914,7 +914,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_field_flags</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -939,7 +939,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_field_name</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_index</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -998,7 +998,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_field_len</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1021,7 +1021,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_field_seek</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1049,7 +1049,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_field_table</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1072,7 +1072,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_field_type</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>field_offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1152,7 +1152,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_insert_id</function></funcdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -1206,8 +1206,8 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_list_dbs</function></funcdef>
- <paramdef>int
+ <funcdef>resource <function>fbsql_list_dbs</function></funcdef>
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -1262,10 +1262,10 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_list_fields</function></funcdef>
+ <funcdef>resource <function>fbsql_list_fields</function></funcdef>
<paramdef>string <parameter>database_name</parameter></paramdef>
<paramdef>string <parameter>table_name</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -1326,9 +1326,9 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_list_tables</function></funcdef>
+ <funcdef>resource <function>fbsql_list_tables</function></funcdef>
<paramdef>string <parameter>database</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -1355,7 +1355,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_num_fields</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -1381,7 +1381,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>fbsql_num_rows</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -1427,14 +1427,9 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_pconnect</function></funcdef>
+ <funcdef>resource <function>fbsql_pconnect</function></funcdef>
<paramdef>string
- <parameter>
- <optional>hostname
- <optional>:port</optional>
- <optional>:/path/to/socket</optional>
- </optional>
- </parameter>
+ <parameter><optional>hostname</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>username</optional></parameter>
@@ -1459,6 +1454,9 @@
<function>fbsql_pconnect</function> acts very much like
<function>fbsql_connect</function> with two major differences.
</para>
+ <para>
+ To set Frontbase server port number, use <function>fbsql_select_db</function>.
+ </para>
<para>
First, when connecting, the function would first try to find a
(persistent) link that's already open with the same host,
@@ -1485,9 +1483,9 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>fbsql_query</function></funcdef>
+ <funcdef>resource <function>fbsql_query</function></funcdef>
<paramdef>string <parameter>query</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter><optional>link_identifier</optional></parameter>
</paramdef>
</funcprototype>
@@ -1585,7 +1583,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>mixed <function>fbsql_result</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>row</parameter></paramdef>
<paramdef>mixed
<parameter>
@@ -1635,7 +1633,7 @@
<funcprototype>
<funcdef>int <function>fbsql_select_db</function></funcdef>
<paramdef>string <parameter>database_name</parameter></paramdef>
- <paramdef>int
+ <paramdef>resource
<parameter>
<optional>link_identifier</optional>
</parameter>
@@ -1683,7 +1681,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_tablename</function></funcdef>
- <paramdef>int <parameter>result</parameter></paramdef>
+ <paramdef>resource <parameter>result</parameter></paramdef>
<paramdef>int <parameter>i</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1721,8 +1719,8 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>fbsql_warnings</function></funcdef>
- <paramdef>bool
+ <funcdef>boolean <function>fbsql_warnings</function></funcdef>
+ <paramdef>boolean
<parameter>
<optional>OnOff</optional>
</parameter>
