CVS update: php3/doc/functions

Date: Saturday December 19, 1998 @ 21:29 Author: sas Update of /repository/php3/doc/functions In directory asf:/u/temp/cvs-serv27786/doc/functions Modified Files: msql.sgml Log Message: major clean up of mSQL module - reduced code size by using some macros - storing results not by result id, but by query id - affected rows support - documentation correction - tests/msql.php3 has some simple tests Index: php3/doc/functions/msql.sgml diff -c php3/doc/functions/msql.sgml:1.20 php3/doc/functions/msql.sgml:1.21 *** php3/doc/functions/msql.sgml:1.20 Wed Dec 9 21:07:39 1998 --- php3/doc/functions/msql.sgml Sat Dec 19 21:29:23 1998 *************** *** 13,23 **** <funcsynopsis> <funcdef>int <function>msql</function></funcdef> <paramdef>string <parameter>database</parameter></paramdef> ! <paramdef>string <parameter>query</parameter></paramdef> <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> ! Returns a positive mSQL result identifier to the query result, or false on error. <para> msql() selects a database and executes a query on it. If the --- 13,23 ---- <funcsynopsis> <funcdef>int <function>msql</function></funcdef> <paramdef>string <parameter>database</parameter></paramdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> ! Returns a positive mSQL query identifier to the query result, or false on error. <para> msql() selects a database and executes a query on it. If the *************** *** 30,35 **** --- 30,57 ---- </refsect1> </refentry> + <refentry id="function.msql-affected-rows"> + <refnamediv> + <refname>msql_affected_rows</refname> + <refpurpose>returns number of affected rows</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>msql_affected_rows</function></funcdef> + <paramdef>int <parameter>query_identifier</parameter></paramdef> + </funcsynopsis> + <para> + Returns number of affected ("touched") rows by a specific query + (i.e. the number of rows returned by a SELECT, the number of rows + modified by an update, or the number of rows removed by a delete). + <para> + See also: + <function>msql_query</function> + + </refsect1> + </refentry> + <refentry id="function.msql-close"> <refnamediv> <refname>msql_close</refname> *************** *** 148,161 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_data_seek</function></funcdef> ! <paramdef>int <parameter>result_identifier</parameter></paramdef> <paramdef>int <parameter>row_number</parameter></paramdef> </funcsynopsis> <para> Returns true on success, false on failure. <para> msql_data_seek() moves the internal row pointer of the mSQL ! result associated with the specified result identifier to pointer to the specifyed row number. The next call to <function>msql_fetch_row</function> would return that row. <para> --- 170,183 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_data_seek</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>row_number</parameter></paramdef> </funcsynopsis> <para> Returns true on success, false on failure. <para> msql_data_seek() moves the internal row pointer of the mSQL ! result associated with the specified query identifier to pointer to the specifyed row number. The next call to <function>msql_fetch_row</function> would return that row. <para> *************** *** 174,180 **** <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_dbname</function></funcdef> ! <paramdef>string <parameter>result</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> --- 196,202 ---- <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_dbname</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> *************** *** 249,255 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fetch_array</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if --- 271,277 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fetch_array</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if *************** *** 284,290 **** <title>Description</title> <funcsynopsis> <funcdef>object <function>msql_fetch_field</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>field_offset</parameter></paramdef> </funcsynopsis> <para> --- 306,312 ---- <title>Description</title> <funcsynopsis> <funcdef>object <function>msql_fetch_field</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>field_offset</parameter></paramdef> </funcsynopsis> <para> *************** *** 326,332 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fetch_object</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> Returns an object with properties that correspond to the fetched --- 348,354 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fetch_object</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> Returns an object with properties that correspond to the fetched *************** *** 358,371 **** <title>Description</title> <funcsynopsis> <funcdef>array <function>msql_fetch_row</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if there are no more rows. <para> msql_fetch_row() fetches one row of data from the result ! associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. <para> --- 380,393 ---- <title>Description</title> <funcsynopsis> <funcdef>array <function>msql_fetch_row</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if there are no more rows. <para> msql_fetch_row() fetches one row of data from the result ! associated with the specified query identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. <para> *************** *** 389,400 **** <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldname</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> msql_fieldname() returns the name of the specified field. ! <parameter>result</parameter> is the result identifier, and <parameter>field</parameter> is the field index. <literal>msql_fieldname($result, 2);</literal> will return the name of the second field in the result associated with the result --- 411,422 ---- <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldname</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> msql_fieldname() returns the name of the specified field. ! <parameter>query_identifier</parameter> is the query identifier, and <parameter>field</parameter> is the field index. <literal>msql_fieldname($result, 2);</literal> will return the name of the second field in the result associated with the result *************** *** 412,418 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_field_seek</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>field_offset</parameter></paramdef> </funcsynopsis> <para> --- 434,440 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_field_seek</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>field_offset</parameter></paramdef> </funcsynopsis> <para> *************** *** 435,441 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fieldtable</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> --- 457,463 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fieldtable</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> *************** *** 454,460 **** <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldtype</function></funcdef> ! <paramdef>string <parameter>result</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> --- 476,482 ---- <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldtype</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> *************** *** 475,481 **** <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldflags</function></funcdef> ! <paramdef>string <parameter>result</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> --- 497,503 ---- <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_fieldflags</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> *************** *** 495,501 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fieldlen</function></funcdef> ! <paramdef>string <parameter>result</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> --- 517,523 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_fieldlen</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> *************** *** 513,523 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_free_result</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> <function>msql_free_result</function> frees the memory associated ! with <parameter>result</parameter>. When PHP completes a request, this memory is freed automatically, so you only need to call this function when you want to make sure you don't use too much memory while the script is running. --- 535,545 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_free_result</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> <function>msql_free_result</function> frees the memory associated ! with <parameter>query_identifier</parameter>. When PHP completes a request, this memory is freed automatically, so you only need to call this function when you want to make sure you don't use too much memory while the script is running. *************** *** 558,564 **** <function>msql_fieldlen</function>, <function>msql_fieldname</function>, and <function>msql_fieldtype</function>. ! A result identifier is a positive integer. The function returns <literal>-1</literal> if a error occurs. A string describing the error will be placed in <literal>$phperrmsg</literal>, and unless the function was called as <literal>@msql_list_fields()</literal> --- 580,586 ---- <function>msql_fieldlen</function>, <function>msql_fieldname</function>, and <function>msql_fieldtype</function>. ! A query identifier is a positive integer. The function returns <literal>-1</literal> if a error occurs. A string describing the error will be placed in <literal>$phperrmsg</literal>, and unless the function was called as <literal>@msql_list_fields()</literal> *************** *** 658,664 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_num_fields</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> msql_num_fields() returns the number of fields in a result set. --- 680,686 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_num_fields</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> msql_num_fields() returns the number of fields in a result set. *************** *** 682,688 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_num_rows</function></funcdef> ! <paramdef>string <parameter>result</parameter></paramdef> </funcsynopsis> <para> msql_num_rows() returns the number of rows in a result set. --- 704,710 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_num_rows</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> msql_num_rows() returns the number of rows in a result set. *************** *** 704,710 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_numfields</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> </funcsynopsis> <para> Identical to <function>msql_num_fields</function>. --- 726,732 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_numfields</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> Identical to <function>msql_num_fields</function>. *************** *** 773,779 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_query</function></funcdef> ! <paramdef>string <parameter>query</parameter></paramdef> <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> --- 795,801 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_query</function></funcdef> ! <paramdef>string <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> *************** *** 784,790 **** the function tries to establish a link as if <function>msql_connect</function> was called, and use it. <para> ! Returns a positive mSQL result identifier on success, or false on error. <para> See also: <function>msql</function>, --- 806,812 ---- the function tries to establish a link as if <function>msql_connect</function> was called, and use it. <para> ! Returns a positive mSQL query identifier on success, or false on error. <para> See also: <function>msql</function>, *************** *** 815,821 **** <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_result</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> <paramdef>mixed <parameter>field</parameter></paramdef> </funcsynopsis> --- 837,843 ---- <title>Description</title> <funcsynopsis> <funcdef>int <function>msql_result</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>i</parameter></paramdef> <paramdef>mixed <parameter>field</parameter></paramdef> </funcsynopsis> *************** *** 900,906 **** <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_tablename</function></funcdef> ! <paramdef>int <parameter>result</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> --- 922,928 ---- <title>Description</title> <funcsynopsis> <funcdef>string <function>msql_tablename</function></funcdef> ! <paramdef>int <parameter>query_identifier</parameter></paramdef> <paramdef>int <parameter>field</parameter></paramdef> </funcsynopsis> <para> -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net