CVS update: php3/functions

Date: Monday December 14, 1998 @ 7:58 Author: rasmus Update of /repository/php3/functions In directory asf:/home/rasmus/php3/functions Modified Files: mysql.c Log Message: Add prototype comments (a whole whack of functions are incorrectly documented in the online docs for this module). Index: php3/functions/mysql.c diff -c php3/functions/mysql.c:1.175 php3/functions/mysql.c:1.176 *** php3/functions/mysql.c:1.175 Tue Oct 20 20:26:51 1998 --- php3/functions/mysql.c Mon Dec 14 07:58:36 1998 *************** *** 27,33 **** +----------------------------------------------------------------------+ */ ! /* $Id: mysql.c,v 1.175 1998/10/21 00:26:51 ssb Exp $ */ /* TODO: --- 27,33 ---- +----------------------------------------------------------------------+ */ ! /* $Id: mysql.c,v 1.176 1998/12/14 12:58:36 rasmus Exp $ */ /* TODO: *************** *** 631,647 **** return MySQL_GLOBAL(php3_mysql_module).default_link; } ! void php3_mysql_connect(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_do_connect(INTERNAL_FUNCTION_PARAM_PASSTHRU,0); } void php3_mysql_pconnect(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_do_connect(INTERNAL_FUNCTION_PARAM_PASSTHRU,1); } void php3_mysql_close(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; --- 631,654 ---- return MySQL_GLOBAL(php3_mysql_module).default_link; } ! /* {{{ proto int mysql_connect([string hostname[:port]] [, string username] [, string password]) ! Open a connection to a MySQL Server */ void php3_mysql_connect(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_do_connect(INTERNAL_FUNCTION_PARAM_PASSTHRU,0); } + /* }}} */ + /* {{{ proto int mysql_pconnect([string hostname[:port]] [, string username] [, string password]) + Open a persistent connection to a MySQL Server */ void php3_mysql_pconnect(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_do_connect(INTERNAL_FUNCTION_PARAM_PASSTHRU,1); } + /* }}} */ + /* {{{ proto int mysql_close([int link_identifier]) + Close a MySQL connection */ void php3_mysql_close(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; *************** *** 674,681 **** php3_list_delete(id); RETURN_TRUE; } ! ! void php3_mysql_select_db(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; --- 681,690 ---- php3_list_delete(id); RETURN_TRUE; } ! /* }}} */ ! ! /* {{{ proto int mysql_select_db(string database_name [, int link_identifier]) ! Select a MySQL database */ void php3_mysql_select_db(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; *************** *** 719,725 **** --- 728,737 ---- RETURN_TRUE; } } + /* }}} */ + /* {{{ proto int mysql_create_db(string database_name [, int link_identifier]) + Create a MySQL database */ void php3_mysql_create_db(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; *************** *** 762,769 **** RETURN_FALSE; } } ! void php3_mysql_drop_db(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; --- 774,783 ---- RETURN_FALSE; } } + /* }}} */ ! /* {{{ proto int mysql_drop_db(string database_name [, int link_identifier]) ! Drop (delete) a MySQL database */ void php3_mysql_drop_db(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; *************** *** 806,813 **** RETURN_FALSE; } } ! void php3_mysql_query(INTERNAL_FUNCTION_PARAMETERS) { pval *query,*mysql_link; --- 820,829 ---- RETURN_FALSE; } } ! /* }}} */ + /* {{{ proto int mysql_query(string query [, int link_identifier]) + Send an SQL query to MySQL */ void php3_mysql_query(INTERNAL_FUNCTION_PARAMETERS) { pval *query,*mysql_link; *************** *** 862,869 **** return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! void php3_mysql_db_query(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*query,*mysql_link; --- 878,887 ---- return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } + /* }}} */ ! /* {{{ proto int mysql_db_query(string database_name, string query [, int link_identifier]) ! Send an SQL query to MySQL */ void php3_mysql_db_query(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*query,*mysql_link; *************** *** 926,933 **** return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! void php3_mysql_list_dbs(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; --- 944,953 ---- return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! /* }}} */ + /* {{{ proto int mysql_list_dbs([int link_identifier]) + List databases available on a MySQL server */ void php3_mysql_list_dbs(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; *************** *** 967,974 **** return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! void php3_mysql_list_tables(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; --- 987,996 ---- return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } + /* }}} */ ! /* {{{ proto int mysql_list_tables(string database_name [, int link_identifier]) ! List tables in a MySQL database */ void php3_mysql_list_tables(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*mysql_link; *************** *** 1016,1023 **** return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! void php3_mysql_list_fields(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*table,*mysql_link; --- 1038,1047 ---- return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! /* }}} */ + /* {{{ proto int mysql_list_fields(string database_name, string table_name [, int link_identifier]) + List MySQL result fields */ void php3_mysql_list_fields(INTERNAL_FUNCTION_PARAMETERS) { pval *db,*table,*mysql_link; *************** *** 1066,1073 **** return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } ! void php3_mysql_error(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; --- 1090,1099 ---- return_value->value.lval = php3_list_insert(mysql_result,MySQL_GLOBAL(php3_mysql_module).le_result); return_value->type = IS_LONG; } + /* }}} */ ! /* {{{ proto string mysql_error([int link_identifier]) ! Returns the text of the error message from previous MySQL operation */ void php3_mysql_error(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; *************** *** 1103,1110 **** RETURN_STRING(mysql_error(mysql),1); } ! #ifdef mysql_errno void php3_mysql_errno(INTERNAL_FUNCTION_PARAMETERS) { --- 1129,1138 ---- RETURN_STRING(mysql_error(mysql),1); } ! /* }}} */ + /* {{{ proto int mysql_errno([int link_identifier]) + Returns the number of the error message from previous MySQL operation */ #ifdef mysql_errno void php3_mysql_errno(INTERNAL_FUNCTION_PARAMETERS) { *************** *** 1142,1149 **** RETURN_LONG(mysql_errno(mysql)); } #endif ! void php3_mysql_affected_rows(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; --- 1170,1179 ---- RETURN_LONG(mysql_errno(mysql)); } #endif + /* }}} */ ! /* {{{ proto int mysql_affected_rows([int link_identifier]) ! Get number of affected rows in previous MySQL operation */ void php3_mysql_affected_rows(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; *************** *** 1178,1185 **** return_value->value.lval = (long)mysql_affected_rows(mysql); return_value->type = IS_LONG; } ! void php3_mysql_insert_id(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; --- 1208,1217 ---- return_value->value.lval = (long)mysql_affected_rows(mysql); return_value->type = IS_LONG; } ! /* }}} */ + /* {{{ proto int mysql_insert_id([int link_identifier]) + Get the id generated from the previous INSERT operation */ void php3_mysql_insert_id(INTERNAL_FUNCTION_PARAMETERS) { pval *mysql_link; *************** *** 1214,1221 **** return_value->value.lval = (long)mysql_insert_id(mysql); return_value->type = IS_LONG; } ! void php3_mysql_result(INTERNAL_FUNCTION_PARAMETERS) { pval *result, *row, *field=NULL; --- 1246,1255 ---- return_value->value.lval = (long)mysql_insert_id(mysql); return_value->type = IS_LONG; } ! /* }}} */ + /* {{{ proto int mysql_result(int result, int row [, mixed field]) + Get result data */ void php3_mysql_result(INTERNAL_FUNCTION_PARAMETERS) { pval *result, *row, *field=NULL; *************** *** 1328,1335 **** return_value->type = IS_STRING; } ! void php3_mysql_num_rows(INTERNAL_FUNCTION_PARAMETERS) { pval *result; --- 1362,1371 ---- return_value->type = IS_STRING; } + /* }}} */ ! /* {{{ proto int mysql_num_rows(int result) ! Get number of rows in a result */ void php3_mysql_num_rows(INTERNAL_FUNCTION_PARAMETERS) { pval *result; *************** *** 1354,1361 **** return_value->value.lval = (long)mysql_num_rows(mysql_result); return_value->type = IS_LONG; } ! void php3_mysql_num_fields(INTERNAL_FUNCTION_PARAMETERS) { pval *result; --- 1390,1399 ---- return_value->value.lval = (long)mysql_num_rows(mysql_result); return_value->type = IS_LONG; } ! /* }}} */ + /* {{{ proto int mysql_num_fields(int result) + Get number of fields in a result */ void php3_mysql_num_fields(INTERNAL_FUNCTION_PARAMETERS) { pval *result; *************** *** 1379,1386 **** return_value->value.lval = mysql_num_fields(mysql_result); return_value->type = IS_LONG; } ! void php3_mysql_fetch_row(INTERNAL_FUNCTION_PARAMETERS) { pval *result; --- 1417,1426 ---- return_value->value.lval = mysql_num_fields(mysql_result); return_value->type = IS_LONG; } + /* }}} */ ! /* {{{ proto array mysql_fetch_row(int result) ! Get a result row as an enumerated array */ void php3_mysql_fetch_row(INTERNAL_FUNCTION_PARAMETERS) { pval *result; *************** *** 1432,1438 **** } } } ! static void php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAMETERS) { --- 1472,1478 ---- } } } ! /* }}} */ static void php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAMETERS) { *************** *** 1492,1498 **** } } ! void php3_mysql_fetch_object(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAM_PASSTHRU); --- 1532,1539 ---- } } ! /* {{{ proto object mysql_fetch_object(int result) ! Fetch a result row as an object */ void php3_mysql_fetch_object(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAM_PASSTHRU); *************** *** 1500,1513 **** return_value->type=IS_OBJECT; } } ! void php3_mysql_fetch_array(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAM_PASSTHRU); } ! void php3_mysql_data_seek(INTERNAL_FUNCTION_PARAMETERS) { pval *result,*offset; --- 1541,1558 ---- return_value->type=IS_OBJECT; } } ! /* }}} */ + /* {{{ proto array mysql_fetch_array(int result) + Fetch a result row as an associative array */ void php3_mysql_fetch_array(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_fetch_hash(INTERNAL_FUNCTION_PARAM_PASSTHRU); } ! /* }}} */ + /* {{{ proto int mysql_data_seek(int result, int row_number) + Move internal result pointer */ void php3_mysql_data_seek(INTERNAL_FUNCTION_PARAMETERS) { pval *result,*offset; *************** *** 1535,1542 **** mysql_data_seek(mysql_result,offset->value.lval); RETURN_TRUE; } ! void php3_mysql_fetch_lengths(INTERNAL_FUNCTION_PARAMETERS) { pval *result; --- 1580,1589 ---- mysql_data_seek(mysql_result,offset->value.lval); RETURN_TRUE; } + /* }}} */ ! /* {{{ proto array mysql_fetch_lengths(int result) ! Get max data size of each column in a result */ void php3_mysql_fetch_lengths(INTERNAL_FUNCTION_PARAMETERS) { pval *result; *************** *** 1571,1577 **** add_index_long(return_value, i, lengths[i]); } } ! static char *php3_mysql_get_field_name(int field_type) { --- 1618,1624 ---- add_index_long(return_value, i, lengths[i]); } } ! /* }}} */ static char *php3_mysql_get_field_name(int field_type) { *************** *** 1621,1627 **** } } ! void php3_mysql_fetch_field(INTERNAL_FUNCTION_PARAMETERS) { pval *result,*field=NULL; --- 1668,1675 ---- } } ! /* {{{ proto object mysql_fetch_field(int result [, int field_offset]) ! Get column information from a result and return as an object */ void php3_mysql_fetch_field(INTERNAL_FUNCTION_PARAMETERS) { pval *result,*field=NULL; *************** *** 1682,1689 **** add_property_long(return_value, "unsigned",(mysql_field->flags&UNSIGNED_FLAG?1:0)); add_property_long(return_value, "zerofill",(mysql_field->flags&ZEROFILL_FLAG?1:0)); } ! void php3_mysql_field_seek(INTERNAL_FUNCTION_PARAMETERS) { pval *result, *offset; --- 1730,1739 ---- add_property_long(return_value, "unsigned",(mysql_field->flags&UNSIGNED_FLAG?1:0)); add_property_long(return_value, "zerofill",(mysql_field->flags&ZEROFILL_FLAG?1:0)); } ! /* }}} */ + /* {{{ proto int mysql_field_seek(int result, int field_offset) + Set result pointer to a specific field offset */ void php3_mysql_field_seek(INTERNAL_FUNCTION_PARAMETERS) { pval *result, *offset; *************** *** 1711,1718 **** mysql_field_seek(mysql_result,offset->value.lval); RETURN_TRUE; } - #define PHP3_MYSQL_FIELD_NAME 1 #define PHP3_MYSQL_FIELD_TABLE 2 #define PHP3_MYSQL_FIELD_LEN 3 --- 1761,1768 ---- mysql_field_seek(mysql_result,offset->value.lval); RETURN_TRUE; } + /* }}} */ #define PHP3_MYSQL_FIELD_NAME 1 #define PHP3_MYSQL_FIELD_TABLE 2 #define PHP3_MYSQL_FIELD_LEN 3 *************** *** 1845,1877 **** RETURN_FALSE; } } - void php3_mysql_field_name(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_NAME); } void php3_mysql_field_table(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_TABLE); } void php3_mysql_field_len(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_LEN); } void php3_mysql_field_type(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_TYPE); } void php3_mysql_field_flags(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_FLAGS); } void php3_mysql_free_result(INTERNAL_FUNCTION_PARAMETERS) { pval *result; --- 1895,1943 ---- RETURN_FALSE; } } + /* {{{ proto string mysql_field_name(int result, int field_index) + Get the name of the specified field in a result */ void php3_mysql_field_name(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_NAME); } + /* }}} */ + /* {{{ proto string mysql_field_table(int result, int field_offset) + Get name of the table the specified field is in */ void php3_mysql_field_table(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_TABLE); } + /* }}} */ + /* {{{ proto int mysql_field_len(int result, int field_offet) + Returns the length of the specified field */ void php3_mysql_field_len(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_LEN); } + /* }}} */ + /* {{{ proto string mysql_field_type(int result, int field_offset) + Get the type of the specified field in a result */ void php3_mysql_field_type(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_TYPE); } + /* }}} */ + /* {{{ proto string mysql_field_flags(int result, int field_offset) + Get the flags associated with the specified field in a result */ void php3_mysql_field_flags(INTERNAL_FUNCTION_PARAMETERS) { php3_mysql_field_info(INTERNAL_FUNCTION_PARAM_PASSTHRU,PHP3_MYSQL_FIELD_FLAGS); } + /* }}} */ + /* {{{ proto int mysql_free_result(int result) + Free result memory */ void php3_mysql_free_result(INTERNAL_FUNCTION_PARAMETERS) { pval *result; *************** *** 1897,1903 **** php3_list_delete(result->value.lval); RETURN_TRUE; } ! #endif /* --- 1963,1969 ---- php3_list_delete(result->value.lval); RETURN_TRUE; } ! /* }}} */ #endif /* -- 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