completed descriptions for all functions starting with b
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpsyntax.xml
index 342cf52..28d927f 100644 (file)
@@ -78,34 +78,46 @@ about the given resource and returns this information in a class.
         <phpsyntax function="assert_options"></phpsyntax>
         <phpsyntax function="atan"></phpsyntax>
         <phpsyntax function="atan2"></phpsyntax>
-        <phpsyntax function="base64_decode"></phpsyntax>
-        <phpsyntax function="base64_encode"></phpsyntax>
-        <phpsyntax function="base_convert"></phpsyntax>
-        <phpsyntax function="basename"></phpsyntax>
-        <phpsyntax function="bcadd"></phpsyntax>
-        <phpsyntax function="bccomp"></phpsyntax>
-        <phpsyntax function="bcdiv"></phpsyntax>
-        <phpsyntax function="bcmod"></phpsyntax>
-        <phpsyntax function="bcmul"></phpsyntax>
-        <phpsyntax function="bcpow"></phpsyntax>
-        <phpsyntax function="bcscale"></phpsyntax>
-        <phpsyntax function="bcsqrt"></phpsyntax>
-        <phpsyntax function="bcsub"></phpsyntax>
-        <phpsyntax function="bin2hex"></phpsyntax>
-        <phpsyntax function="bind"></phpsyntax>
-        <phpsyntax function="bindec"></phpsyntax>
-        <phpsyntax function="bindtextdomain"></phpsyntax>
-        <phpsyntax function="build_iovec"></phpsyntax>
-        <phpsyntax function="bzclose"></phpsyntax>
-        <phpsyntax function="bzcompress"></phpsyntax>
-        <phpsyntax function="bzdecompress"></phpsyntax>
-        <phpsyntax function="bzerrno"></phpsyntax>
-        <phpsyntax function="bzerror"></phpsyntax>
-        <phpsyntax function="bzerrstr"></phpsyntax>
-        <phpsyntax function="bzflush"></phpsyntax>
-        <phpsyntax function="bzopen"></phpsyntax>
-        <phpsyntax function="bzread"></phpsyntax>
-        <phpsyntax function="bzwrite"></phpsyntax>
+        <phpsyntax function="base64_decode" usage="string base64_decode ( string encoded_data)">base64_decode() decodes encoded_data and returns the original data. The returned data may be binary.</phpsyntax>
+        <phpsyntax function="base64_encode" usage="string base64_encode ( string data)">base64_encode returns data encoded with base64. This encoding is designed to make binary data survive transport through transport layers that are not 8-bit clean, such as mail bodies.</phpsyntax>
+        <phpsyntax function="base_convert" usage="string base_convert ( string number, int frombase, int tobase)">Returns a string containing number represented in base tobase. The base in which number is given is specified in frombase. Both frombase and tobase have to be between 2 and 36, inclusive. Digits in numbers with a base higher than 10 will be represented with the letters a-z, with a meaning 10, b meaning 11 and z meaning 35.</phpsyntax>
+        <phpsyntax function="basename" usage="string basename ( string path [, string suffix])">Given a string containing a path to a file, this function will return the base name of the file. If the filename ends in suffix this will also be cut off.</phpsyntax>
+        <phpsyntax function="bcadd" usage="string bcadd ( string left_operand, string right_operand [, int scale])">Adds the left_operand to the right_operand and returns the sum in a string. The optional scale parameter is used to set the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bccomp" usage="int bccomp ( string left_operand, string right_operand [, int scale])">Compares the left_operand to the right_operand and returns the result as an integer. The optional scale parameter is used to set the number of digits after the decimal place which will be used in the comparison. The return value is 0 if the two operands are equal. If the left_operand is larger than the right_operand the return value is +1 and if the left_operand is less than the right_operand the return value is -1.</phpsyntax>
+        <phpsyntax function="bcdiv" usage="string bcdiv ( string left_operand, string right_operand [, int scale])">Divides the left_operand by the right_operand and returns the result. The optional scale sets the number of digits after the decimal place in the result. </phpsyntax>
+        <phpsyntax function="bcmod" usage="string bcmod ( string left_operand, string modulus)">Get the modulus of the left_operand using modulus.</phpsyntax>
+        <phpsyntax function="bcmul" usage="string bcmul ( string left_operand, string right_operand [, int scale])">Multiply the left_operand by the right_operand and returns the result. The optional scale sets the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bcpow" usage="string bcpow ( string x, int y [, int scale])">Raise x to the power y. The optional scale can be used to set the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bcscale" usage="string bcscale ( int scale)">This function sets the default scale parameter for all subsequent bc math functions that do not explicitly specify a scale parameter.</phpsyntax>
+        <phpsyntax function="bcsqrt" usage="string bcsqrt ( string operand [, int scale])">Return the square root of the operand. The optional scale parameter sets the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bcsub" usage="string bcsub ( string left_operand, string right_operand [, int scale])">Subtracts the right_operand from the left_operand and returns the result in a string. The optional scale parameter is used to set the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bin2hex" usage="string bin2hex ( string str)">Returns an ASCII string containing the hexadecimal representation of str. The conversion is done byte-wise with the high-nibble first.</phpsyntax>
+        <phpsyntax function="bindec" usage="int bindec ( string binary_string)">
+Returns the decimal equivalent of the binary number represented by the binary_string argument. 
+
+bindec() converts a binary number to an integer. The largest number that can be converted is 31 bits of 1's or 2147483647 in decimal.</phpsyntax>
+        <phpsyntax function="bindtextdomain" usage="string bindtextdomain ( string domain, string directory)">The bindtextdomain() function sets the path for a domain.</phpsyntax>
+        <phpsyntax function="bzclose" usage="int bzclose ( resource bz)">Closes the bzip2 file referenced by the pointer bz.</phpsyntax>
+        <phpsyntax function="bzcompress" usage="string bzcompress ( string source [, int blocksize [, int workfactor]])">
+bzcompress() compresses the source string and returns it as bzip2 encoded data. 
+
+The optional parameter blocksize specifies the blocksize used during compression and should be a number from 1 to 9 with 9 giving the best compression, but using more resources to do so. blocksize defaults to 4. 
+
+The optional parameter workfactor controls how the compression phase behaves when presented with worst case, highly repetitive, input data. The value can be between 0 and 250 with 0 being a special case and 30 being the default value. Regardless of the workfactor, the generated output is the same.</phpsyntax>
+        <phpsyntax function="bzdecompress" usage="string bzdecompress ( string source [, int small])">bzdecompress() decompresses the source string containing bzip2 encoded data and returns it. If the optional parameter small is TRUE , an alternative decompression algorithm will be used which uses less memory (the maximum memory requirement drops to around 2300K) but works at roughly half the speed.</phpsyntax>
+        <phpsyntax function="bzerrno" usage="int bzerrno ( resource bz)">Returns the error number of any bzip2 error returned by the file pointer bz.</phpsyntax>
+        <phpsyntax function="bzerror" usage="array bzerror ( resource bz)">Returns the error number and error string, in an associative array, of any bzip2 error returned by the file pointer bz.</phpsyntax>
+        <phpsyntax function="bzerrstr" usage="string bzerrstr ( resource bz)">Returns the error string of any bzip2 error returned by the file pointer bz.</phpsyntax>
+        <phpsyntax function="bzflush" usage="int bzflush ( resource bz)">
+Forces a write of all buffered bzip2 data for the file pointer bz.
+
+Returns TRUE on success or FALSE on failure.</phpsyntax>
+        <phpsyntax function="bzopen" usage="resource bzopen ( string filename, string mode)">
+Opens a bzip2 (.bz2) file for reading or writing. filename is the name of the file to open. mode is similar to the fopen() function (`r' for read, `w' for write, etc.). 
+
+If the open fails, the function returns FALSE, otherwise it returns a pointer to the newly opened file.</phpsyntax>
+        <phpsyntax function="bzread" usage="string bzread ( resource bz [, int length])">bzread() reads up to length bytes from the bzip2 file pointer referenced by bz. Reading stops when length (uncompressed) bytes have been read or EOF is reached, whichever comes first. If the optional parameter length is not specified, bzread() will read 1024 (uncompressed) bytes at a time.</phpsyntax>
+        <phpsyntax function="bzwrite" usage="int bzwrite ( resource bz, string data [, int length])">bzwrite() writes the contents of the string data to the bzip2 file stream pointed to by bz. If the optional length argument is given, writing will stop after length (uncompressed) bytes have been written or the end of string is reached, whichever comes first.</phpsyntax>
         <phpsyntax function="call_user_func"></phpsyntax>
         <phpsyntax function="call_user_func_array"></phpsyntax>
         <phpsyntax function="call_user_method"></phpsyntax>
@@ -1336,56 +1348,142 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="muscat_give"></phpsyntax>
         <phpsyntax function="muscat_setup"></phpsyntax>
         <phpsyntax function="muscat_setup_net"></phpsyntax>
-        <phpsyntax function="mysql"></phpsyntax>
-        <phpsyntax function="mysql_affected_rows"></phpsyntax>
-        <phpsyntax function="mysql_close"></phpsyntax>
-        <phpsyntax function="mysql_connect"></phpsyntax>
-        <phpsyntax function="mysql_create_db"></phpsyntax>
-        <phpsyntax function="mysql_createdb"></phpsyntax>
-        <phpsyntax function="mysql_data_seek"></phpsyntax>
-        <phpsyntax function="mysql_db_name"></phpsyntax>
-        <phpsyntax function="mysql_db_query"></phpsyntax>
-        <phpsyntax function="mysql_dbname"></phpsyntax>
-        <phpsyntax function="mysql_drop_db"></phpsyntax>
-        <phpsyntax function="mysql_dropdb"></phpsyntax>
-        <phpsyntax function="mysql_errno"></phpsyntax>
-        <phpsyntax function="mysql_error"></phpsyntax>
-        <phpsyntax function="mysql_escape_string"></phpsyntax>
-        <phpsyntax function="mysql_fetch_array"></phpsyntax>
-        <phpsyntax function="mysql_fetch_assoc"></phpsyntax>
-        <phpsyntax function="mysql_fetch_field"></phpsyntax>
-        <phpsyntax function="mysql_fetch_lengths"></phpsyntax>
-        <phpsyntax function="mysql_fetch_object"></phpsyntax>
-        <phpsyntax function="mysql_fetch_row"></phpsyntax>
-        <phpsyntax function="mysql_field_flags"></phpsyntax>
-        <phpsyntax function="mysql_field_len"></phpsyntax>
-        <phpsyntax function="mysql_field_name"></phpsyntax>
-        <phpsyntax function="mysql_field_seek"></phpsyntax>
-        <phpsyntax function="mysql_field_table"></phpsyntax>
-        <phpsyntax function="mysql_field_type"></phpsyntax>
-        <phpsyntax function="mysql_fieldflags"></phpsyntax>
-        <phpsyntax function="mysql_fieldlen"></phpsyntax>
-        <phpsyntax function="mysql_fieldname"></phpsyntax>
-        <phpsyntax function="mysql_fieldtable"></phpsyntax>
-        <phpsyntax function="mysql_fieldtype"></phpsyntax>
-        <phpsyntax function="mysql_free_result"></phpsyntax>
-        <phpsyntax function="mysql_freeresult"></phpsyntax>
-        <phpsyntax function="mysql_get_client_info"></phpsyntax>
-        <phpsyntax function="mysql_get_host_info"></phpsyntax>
-        <phpsyntax function="mysql_get_proto_info"></phpsyntax>
-        <phpsyntax function="mysql_get_server_info"></phpsyntax>
-        <phpsyntax function="mysql_insert_id"></phpsyntax>
-        <phpsyntax function="mysql_list_dbs"></phpsyntax>
-        <phpsyntax function="mysql_list_fields"></phpsyntax>
-        <phpsyntax function="mysql_list_tables"></phpsyntax>
-        <phpsyntax function="mysql_listdbs"></phpsyntax>
-        <phpsyntax function="mysql_listfields"></phpsyntax>
-        <phpsyntax function="mysql_listtables"></phpsyntax>
-        <phpsyntax function="mysql_num_fields"></phpsyntax>
-        <phpsyntax function="mysql_num_rows"></phpsyntax>
-        <phpsyntax function="mysql_numfields"></phpsyntax>
-        <phpsyntax function="mysql_numrows"></phpsyntax>
-        <phpsyntax function="mysql_pconnect"></phpsyntax>
+        <phpsyntax function="mysql_affected_rows" usage="int mysql_affected_rows ( [resource link_identifier])">
+mysql_affected_rows() returns the number of rows affected by the last INSERT, 
+UPDATE or DELETE query associated with link_identifier. 
+If the link identifier isn't specified, the last link opened by mysql_connect() is assumed. 
+
+Note: If you are using transactions, you need to call mysql_affected_rows() 
+after your INSERT, UPDATE, or DELETE query, not after the commit. 
+
+If the last query was a DELETE query with no WHERE clause, 
+all of the records will have been deleted from the table but this function will return zero. 
+
+Note: When using UPDATE, MySQL will not update columns where the new value is the same as the old value. 
+This creates the possiblity that mysql_affected_rows() may not actually equal the number of rows matched, 
+only the number of rows that were literally affected by the query. 
+
+mysql_affected_rows() does not work with SELECT statements; only on statements which modify records. 
+To retrieve the number of rows returned by a SELECT, use mysql_num_rows(). 
+
+If the last query failed, this function will return -1. 
+        </phpsyntax>
+        <phpsyntax function="mysql_close" usage="bool mysql_close ( [resource link_identifier])"></phpsyntax>
+        <phpsyntax function="mysql_connect" usage="resource mysql_connect ( [string server [, string username [, string password [, bool new_link [, int client_flags]]]]])"></phpsyntax>
+        <phpsyntax function="mysql_create_db" usage="bool mysql_create_db ( string database name [, resource link_identifier])"></phpsyntax>
+        <phpsyntax function="mysql_data_seek" usage="bool mysql_data_seek ( resource result_identifier, int row_number)"></phpsyntax>
+        <phpsyntax function="mysql_db_name" usage="string mysql_db_name ( resource result, int row [, mixed field])"></phpsyntax>
+        <phpsyntax function="mysql_db_query" usage="resource mysql_db_query ( string database, string query [, resource link_identifier])"></phpsyntax>
+        <phpsyntax function="mysql_drop_db" usage="bool mysql_drop_db ( string database_name [, resource link_identifier])">
+Returns TRUE on success or FALSE on failure. 
+
+mysql_drop_db() attempts to drop (remove) an entire database from the server 
+associated with the specified link identifier. 
+
+For downward compatibility mysql_dropdb() can also be used. This is deprecated, however. 
+
+Note: The function mysql_drop_db() is deprecated. 
+It is preferable to use mysql_query() to issue a SQL DROP DATABASE statement instead. 
+        </phpsyntax>
+        <phpsyntax function="mysql_errno" usage="int mysql_errno ( [resource link_identifier])">
+Returns the error number from the last MySQL function, or 0 (zero) if no error occurred. 
+
+Errors coming back from the MySQL database backend no longer issue warnings. 
+Instead, use mysql_errno() to retrieve the error code. 
+Note that this function only returns the error code from the most recently executed 
+MySQL function (not including mysql_error() and mysql_errno()), so if you want to use it, 
+make sure you check the value before calling another MySQL function. 
+        </phpsyntax>
+        <phpsyntax function="mysql_error" usage="string mysql_error ( [resource link_identifier])">
+Returns the error text from the last MySQL function, or '' (the empty string) if no error occurred. 
+
+Errors coming back from the MySQL database backend no longer issue warnings. 
+Instead, use mysql_error() to retrieve the error text. 
+Note that this function only returns the error text from the most recently 
+executed MySQL function (not including mysql_error() and mysql_errno()), 
+so if you want to use it, make sure you check the value before calling another MySQL function.         
+        </phpsyntax>
+        <phpsyntax function="mysql_escape_string" usage="string mysql_escape_string ( string unescaped_string)"></phpsyntax>
+        <phpsyntax function="mysql_fetch_array" usage="array mysql_fetch_array ( resource result [, int result_type])">
+Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
+
+mysql_fetch_array() is an extended version of mysql_fetch_row(). 
+In addition to storing the data in the numeric indices of the result array, 
+it also stores the data in associative indices, using the field names as keys. 
+
+If two or more columns of the result have the same field names, 
+the last column will take precedence. To access the other column(s) of the same name, 
+you must use the numeric index of the column or make an alias for the column. 
+For aliased columns, you cannot access the contents with the original column name.         
+        </phpsyntax>
+        <phpsyntax function="mysql_fetch_assoc" usage="array mysql_fetch_assoc ( resource result)">
+Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
+
+mysql_fetch_assoc() is equivalent to calling mysql_fetch_array() with MYSQL_ASSOC 
+for the optional second parameter. It only returns an associative array. 
+This is the way mysql_fetch_array() originally worked. 
+If you need the numeric indices as well as the associative, use mysql_fetch_array(). 
+
+If two or more columns of the result have the same field names, the last column will take precedence. 
+To access the other column(s) of the same name, you either need to access the result 
+with numeric indices by using mysql_fetch_row() or add alias names. 
+
+An important thing to note is that using mysql_fetch_assoc() is not significantly slower 
+than using mysql_fetch_row(), while it provides a significant added value. 
+        </phpsyntax>
+        <phpsyntax function="mysql_fetch_field" usage="object mysql_fetch_field ( resource result [, int field_offset])">
+Returns an object containing field information. 
+
+mysql_fetch_field() can be used in order to obtain information about fields in a certain query result. 
+If the field offset isn't specified, the next field that wasn't yet retrieved by mysql_fetch_field() 
+is retrieved. 
+
+The properties of the object are: 
+name - column name 
+table - name of the table the column belongs to 
+max_length - maximum length of the column 
+not_null - 1 if the column cannot be NULL 
+primary_key - 1 if the column is a primary key 
+unique_key - 1 if the column is a unique key 
+multiple_key - 1 if the column is a non-unique key 
+numeric - 1 if the column is numeric 
+blob - 1 if the column is a BLOB 
+type - the type of the column 
+unsigned - 1 if the column is unsigned 
+zerofill - 1 if the column is zero-filled
+        </phpsyntax>
+        <phpsyntax function="mysql_fetch_lengths" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fetch_object" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fetch_row" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_flags" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_len" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_name" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_seek" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_table" usage=""></phpsyntax>
+        <phpsyntax function="mysql_field_type" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fieldflags" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fieldlen" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fieldname" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fieldtable" usage=""></phpsyntax>
+        <phpsyntax function="mysql_fieldtype" usage=""></phpsyntax>
+        <phpsyntax function="mysql_free_result" usage=""></phpsyntax>
+        <phpsyntax function="mysql_freeresult" usage=""></phpsyntax>
+        <phpsyntax function="mysql_get_client_info" usage=""></phpsyntax>
+        <phpsyntax function="mysql_get_host_info" usage=""></phpsyntax>
+        <phpsyntax function="mysql_get_proto_info" usage=""></phpsyntax>
+        <phpsyntax function="mysql_get_server_info" usage=""></phpsyntax>
+        <phpsyntax function="mysql_insert_id" usage=""></phpsyntax>
+        <phpsyntax function="mysql_list_dbs" usage=""></phpsyntax>
+        <phpsyntax function="mysql_list_fields" usage=""></phpsyntax>
+        <phpsyntax function="mysql_list_tables" usage=""></phpsyntax>
+        <phpsyntax function="mysql_listdbs" usage=""></phpsyntax>
+        <phpsyntax function="mysql_listfields" usage=""></phpsyntax>
+        <phpsyntax function="mysql_listtables" usage=""></phpsyntax>
+        <phpsyntax function="mysql_num_fields" usage=""></phpsyntax>
+        <phpsyntax function="mysql_num_rows" usage=""></phpsyntax>
+        <phpsyntax function="mysql_numfields" usage=""></phpsyntax>
+        <phpsyntax function="mysql_numrows" usage=""></phpsyntax>
+        <phpsyntax function="mysql_pconnect" usage=""></phpsyntax>
         <phpsyntax function="mysql_query" usage="resource mysql_query ( string query [, resource link_identifier [, int result_mode]])">
 mysql_query() sends a query to the currently active database on the server 
 that's associated with the specified link identifier.