Eclipse 3M7
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpsyntax.xml
index e00ee9e..fa5fa0a 100644 (file)
@@ -447,7 +447,7 @@ This function is identical to ereg_replace() except that this ignores case disti
         <phpsyntax function="exp"></phpsyntax>
         <phpsyntax function="explode" usage="array explode ( string separator, string string [, int limit])">Returns an array of strings, each of which is a substring of string formed by splitting it on boundaries formed by the string separator.
 If limit is set, the returned array will contain a maximum of limit elements with the last element containing the rest of string.
-If separator is an empty string (""), explode() will return FALSE. If separator contains a value that is not contained in string, 
+If separator is an empty string (&quot;&quot;), explode() will return FALSE. If separator contains a value that is not contained in string, 
 then explode() will return an array containing string. 
 Note: The limit parameter was added in PHP 4.0.1 
         </phpsyntax>
@@ -538,6 +538,9 @@ This function will not work on remote files; the file to be examined must be acc
 The results of this function are cached. See clearstatcache() for more details. 
 Using Windows shares: On windows, use //computername/share/filename or \\\\computername\share\filename to check files on network shares. 
         </phpsyntax>
+        <phpsyntax function="file_get_contents" usage="string file_get_contents ( string filename [, bool use_include_path [, resource context]])">Identical to file(), except that file_get_contents() returns the file in a string. On failure, file_get_contents() will return FALSE. 
+file_get_contents() is the preferred way to read the contents of a file into a string. It will use memory mapping techniques if supported by your OS to enhance performance.
+        </phpsyntax>
         <phpsyntax function="fileatime"></phpsyntax>
         <phpsyntax function="filectime"></phpsyntax>
         <phpsyntax function="filegroup"></phpsyntax>
@@ -1117,6 +1120,7 @@ if ENT_NOQUOTES is set neither single nor double quotes are translated.
         <phpsyntax function="ircg_set_current"></phpsyntax>
         <phpsyntax function="ircg_topic"></phpsyntax>
         <phpsyntax function="ircg_whois"></phpsyntax>
+        <phpsyntax function="is_a" usage="bool is_a ( object object, string class_name)">This function returns TRUE if the object is of this class or has this class as one of its parents, FALSE otherwise.</phpsyntax>
         <phpsyntax function="is_array"></phpsyntax>
         <phpsyntax function="is_bool"></phpsyntax>
         <phpsyntax function="is_dir"></phpsyntax>
@@ -1462,12 +1466,12 @@ 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_close" usage="bool mysql_close ( [resource link_identifier])">Close MySQL connection</phpsyntax>
+        <phpsyntax function="mysql_connect" usage="resource mysql_connect ( [string server [, string username [, string password [, bool new_link [, int client_flags]]]]])">Open a connection to a MySQL Server</phpsyntax>
+        <phpsyntax function="mysql_create_db" usage="bool mysql_create_db ( string database name [, resource link_identifier])">Create a MySQL database</phpsyntax>
+        <phpsyntax function="mysql_data_seek" usage="bool mysql_data_seek ( resource result_identifier, int row_number)">Move internal result pointer</phpsyntax>
+        <phpsyntax function="mysql_db_name" usage="string mysql_db_name ( resource result, int row [, mixed field])">Get result data</phpsyntax>
+        <phpsyntax function="mysql_db_query" usage="resource mysql_db_query ( string database, string query [, resource link_identifier])">Send a MySQL query</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. 
 
@@ -1546,38 +1550,30 @@ 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_fetch_lengths" usage="array mysql_fetch_lengths ( resource result)">Get the length of each output in a result </phpsyntax>
+        <phpsyntax function="mysql_fetch_object" usage="object mysql_fetch_object ( resource result)">Fetch a result row as an object</phpsyntax>
+        <phpsyntax function="mysql_fetch_row" usage="array mysql_fetch_row ( resource result)">Get a result row as an enumerated array</phpsyntax>
+        <phpsyntax function="mysql_field_flags" usage="string mysql_field_flags ( resource result, int field_offset)">Get the flags associated with the specified field in a result</phpsyntax>
+        <phpsyntax function="mysql_field_len" usage="int mysql_field_len ( resource result, int field_offset)">Returns the length of the specified field </phpsyntax>
+        <phpsyntax function="mysql_field_name" usage="string mysql_field_name ( resource result, int field_index)">Get the name of the specified field in a result </phpsyntax>
+        <phpsyntax function="mysql_field_seek" usage="int mysql_field_seek ( resource result, int field_offset)">Set result pointer to a specified field offset </phpsyntax>
+        <phpsyntax function="mysql_field_table" usage="string mysql_field_table ( resource result, int field_offset)">Get name of the table the specified field is in </phpsyntax>
+        <phpsyntax function="mysql_field_type" usage="string mysql_field_type ( resource result, int field_offset)">Get the type of the specified field in a result </phpsyntax>
+        <phpsyntax function="mysql_free_result" usage="bool mysql_free_result ( resource result)">Free result memory</phpsyntax>
+        <phpsyntax function="mysql_get_client_info" usage="string mysql_get_client_info ( void)">Get MySQL client info</phpsyntax>
+        <phpsyntax function="mysql_get_host_info" usage="string mysql_get_host_info ( [resource link_identifier])">Get MySQL host info</phpsyntax>
+        <phpsyntax function="mysql_get_proto_info" usage="int mysql_get_proto_info ( [resource link_identifier])">Get MySQL protocol info</phpsyntax>
+        <phpsyntax function="mysql_get_server_info" usage="string mysql_get_server_info ( [resource link_identifier])">Get MySQL server info</phpsyntax>
+        <phpsyntax function="mysql_info" usage="string mysql_info ( [resource link_identifier])">Get information about the most recent query</phpsyntax>
+        <phpsyntax function="mysql_insert_id" usage="int mysql_insert_id ( [resource link_identifier])">Get the ID generated from the previous INSERT operation </phpsyntax>
+        <phpsyntax function="mysql_list_dbs" usage="resource mysql_list_dbs ( [resource link_identifier])">List databases available on a MySQL server</phpsyntax>
+        <phpsyntax function="mysql_list_fields" usage="resource mysql_list_fields ( string database_name, string table_name [, resource link_identifier])">List MySQL result fields</phpsyntax>
+        <phpsyntax function="mysql_list_processes" usage="resource mysql_list_processes ( [resource link_identifier])">List MySQL processes</phpsyntax>
+        <phpsyntax function="mysql_list_tables" usage="resource mysql_list_tables ( string database [, resource link_identifier])">List tables in a MySQL database</phpsyntax>
+        <phpsyntax function="mysql_num_fields" usage="int mysql_num_fields ( resource result)">Get number of fields in result</phpsyntax>
+        <phpsyntax function="mysql_num_rows" usage="int mysql_num_rows ( resource result)">Get number of rows in result</phpsyntax>
+        <phpsyntax function="mysql_pconnect" usage="resource mysql_pconnect ( [string server [, string username [, string password [, int client_flags]]]])">Open a persistent connection to a MySQL server </phpsyntax>
+        <phpsyntax function="mysql_ping" usage="bool mysql_ping ( [resource link_identifier])">Ping a server connection or reconnect if there is no connection</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. 
@@ -1589,10 +1585,12 @@ The optional result_mode parameter can be MYSQL_USE_RESULT and MYSQL_STORE_RESUL
 It defaults to MYSQL_STORE_RESULT, so the result is buffered. 
 See also mysql_unbuffered_query() for the counterpart of this behaviour. 
         </phpsyntax>
-        <phpsyntax function="mysql_result"></phpsyntax>
-        <phpsyntax function="mysql_select_db"></phpsyntax>
-        <phpsyntax function="mysql_selectdb"></phpsyntax>
-        <phpsyntax function="mysql_tablename"></phpsyntax>
+        <phpsyntax function="mysql_real_escape_string" usage="string mysql_real_escape_string ( string unescaped_string [, resource link_identifier])">Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection.</phpsyntax>
+        <phpsyntax function="mysql_result" usage="mixed mysql_result ( resource result, int row [, mixed field])">Get result data</phpsyntax>
+        <phpsyntax function="mysql_select_db" usage="bool mysql_select_db ( string database_name [, resource link_identifier])">Select a MySQL database</phpsyntax>
+        <phpsyntax function="mysql_stat" usage="string mysql_stat ( [resource link_identifier])">Get current system status</phpsyntax>
+        <phpsyntax function="mysql_tablename" usage="string mysql_tablename ( resource result, int i)">Get table name of field</phpsyntax>
+        <phpsyntax function="mysql_threadid" usage="int mysql_thread_id ( [resource link_identifier])">Return the current thread ID</phpsyntax>
         <phpsyntax function="mysql_unbuffered_query" usage="resource mysql_unbuffered_query ( string query [, resource link_identifier [, int result_mode]])">
 mysql_unbuffered_query() sends a SQL query query to MySQL, without fetching and buffering the 
 result rows automatically, as mysql_query() does. 
@@ -2021,7 +2019,7 @@ Note: This information is also available in the predefined constant PHP_VERSION.
         <phpsyntax function="preg_replace_callback"></phpsyntax>
         <phpsyntax function="preg_split"></phpsyntax>
         <phpsyntax function="prev" usage="mixed prev ( array array)">Rewind the internal array pointer</phpsyntax>
-        <phpsyntax function="print" usage="">
+        <phpsyntax function="print">
 Output a string.
 Outputs arg. Returns TRUE on success or FALSE on failure. 
 print() is not actually a real function (it is a language construct) so you are not required to use parentheses with it. 
@@ -2187,7 +2185,7 @@ This does not indicate whether the user accepted the cookie.
 
 All the arguments except the name argument are optional. 
 If only the name argument is present, the cookie by that name will be deleted from the remote client. 
-You may also replace an argument with an empty string ("") in order to skip that argument. 
+You may also replace an argument with an empty string (&quot;&quot;) in order to skip that argument. 
 Because the expire and secure arguments are integers, they cannot be skipped with an empty string, use a zero (0) instead. 
         </phpsyntax>
         <phpsyntax function="setdepth"></phpsyntax>
@@ -2289,40 +2287,42 @@ will return the original version.
 </phpsyntax>
         <phpsyntax function="str_shuffle" usage="string str_shuffle ( string str)">Randomly shuffles a string</phpsyntax> 
         <phpsyntax function="str_word_count" usage="mixed str_word_count ( string string [, int format])">Return information about words used in a string </phpsyntax>
-        <phpsyntax function="strcasecmp"></phpsyntax>
-        <phpsyntax function="strchr"></phpsyntax>
-        <phpsyntax function="strcmp"></phpsyntax>
-        <phpsyntax function="strcoll"></phpsyntax>
-        <phpsyntax function="strcoll"></phpsyntax>
-        <phpsyntax function="strcspn"></phpsyntax>
+        <phpsyntax function="strcasecmp" usage="int strcasecmp ( string str1, string str2)">Binary safe case-insensitive string comparison </phpsyntax>
+        <phpsyntax function="strchr" usage="string strchr ( string haystack, string needle)">Find the first occurrence of a character.This function is an alias for strstr(), and is identical in every way.</phpsyntax>
+        <phpsyntax function="strcmp" usage="int strcmp ( string str1, string str2)">Binary safe string comparison.
+Returns &lt; 0 if str1 is less than str2; &gt; 0 if str1 is greater than str2, and 0 if they are equal. 
+Note that this comparison is case sensitive. 
+        </phpsyntax>
+        <phpsyntax function="strcoll" usage="int strcoll ( string str1, string str2)">Locale based string comparison</phpsyntax>
+        <phpsyntax function="strcspn" usage="int strcspn ( string str1, string str2)">Find length of initial segment not matching mask </phpsyntax>
         <phpsyntax function="streammp3"></phpsyntax>
         <phpsyntax function="strerror"></phpsyntax>
         <phpsyntax function="strftime"></phpsyntax>
         <phpsyntax function="strftime"></phpsyntax>
-        <phpsyntax function="strip_tags"></phpsyntax>
-        <phpsyntax function="stripcslashes"></phpsyntax>
-        <phpsyntax function="stripslashes"></phpsyntax>
-        <phpsyntax function="stristr"></phpsyntax>
-        <phpsyntax function="strlen"></phpsyntax>
-        <phpsyntax function="strnatcasecmp"></phpsyntax>
-        <phpsyntax function="strnatcmp"></phpsyntax>
-        <phpsyntax function="strncasecmp"></phpsyntax>
-        <phpsyntax function="strncmp"></phpsyntax>
-        <phpsyntax function="strpos"></phpsyntax>
-        <phpsyntax function="strrchr"></phpsyntax>
-        <phpsyntax function="strrev"></phpsyntax>
-        <phpsyntax function="strrpos"></phpsyntax>
-        <phpsyntax function="strspn"></phpsyntax>
-        <phpsyntax function="strstr"></phpsyntax>
-        <phpsyntax function="strtok"></phpsyntax>
-        <phpsyntax function="strtolower"></phpsyntax>
+        <phpsyntax function="strip_tags" usage="string strip_tags ( string str [, string allowable_tags])">Strip HTML and PHP tags from a string</phpsyntax>
+        <phpsyntax function="stripcslashes" usage="string stripcslashes ( string str)">Un-quote string quoted with addcslashes() </phpsyntax>
+        <phpsyntax function="stripslashes" usage="string stripslashes ( string str)">Un-quote string quoted with addslashes() </phpsyntax>
+        <phpsyntax function="stristr" usage="string stristr ( string haystack, string needle)">Case-insensitive strstr() </phpsyntax>
+        <phpsyntax function="strlen" usage="int strlen ( string str)">Get string length</phpsyntax>
+        <phpsyntax function="strnatcasecmp" usage="int strnatcasecmp ( string str1, string str2)">Case insensitive string comparisons using a "natural order" algorithm </phpsyntax>
+        <phpsyntax function="strnatcmp" usage="int strnatcmp ( string str1, string str2)">String comparisons using a "natural order" algorithm </phpsyntax>
+        <phpsyntax function="strncasecmp" usage="int strncasecmp ( string str1, string str2, int len)">Binary safe case-insensitive string comparison of the first n characters </phpsyntax>
+        <phpsyntax function="strncmp" usage="int strncmp ( string str1, string str2, int len)">Binary safe string comparison of the first n characters </phpsyntax>
+        <phpsyntax function="strpos" usage="int strpos ( string haystack, string needle [, int offset])">Find position of first occurrence of a string </phpsyntax>
+        <phpsyntax function="strrchr" usage="string strrchr ( string haystack, string needle)">Find the last occurrence of a character in a string </phpsyntax>
+        <phpsyntax function="strrev" usage="string strrev ( string string)">Reverse a string</phpsyntax>
+        <phpsyntax function="strrpos" usage="int strrpos ( string haystack, char needle)">Find position of last occurrence of a char in a string </phpsyntax>
+        <phpsyntax function="strspn" usage="int strspn ( string str1, string str2)">Find length of initial segment matching mask </phpsyntax>
+        <phpsyntax function="strstr" usage="string strstr ( string haystack, string needle)">Find first occurrence of a string</phpsyntax>
+        <phpsyntax function="strtok" usage="string strtok ( string arg1, string arg2)">Tokenize string</phpsyntax>
+        <phpsyntax function="strtolower" usage="string strtolower ( string str)">Make a string lowercase</phpsyntax>
         <phpsyntax function="strtotime"></phpsyntax>
-        <phpsyntax function="strtoupper"></phpsyntax>
-        <phpsyntax function="strtr"></phpsyntax>
+        <phpsyntax function="strtoupper" usage="string strtoupper ( string string)">Make a string uppercase</phpsyntax>
+        <phpsyntax function="strtr" usage="string strtr ( string str, string from, string to) - string strtr ( string str, array replace_pairs)">Translate certain characters</phpsyntax>
         <phpsyntax function="strval"></phpsyntax>
         <phpsyntax function="substr" usage="string substr(string str, int start [, int length])">Returns part of a string</phpsyntax>
-        <phpsyntax function="substr_count"></phpsyntax>
-        <phpsyntax function="substr_replace"></phpsyntax>
+        <phpsyntax function="substr_count" usage="int substr_count ( string haystack, string needle)">Count the number of substring occurrences</phpsyntax>
+        <phpsyntax function="substr_replace" usage="string substr_replace ( string string, string replacement, int start [, int length])">Replace text within a portion of a string</phpsyntax>
         <phpsyntax function="swf_actiongeturl"></phpsyntax>
         <phpsyntax function="swf_actiongotoframe"></phpsyntax>
         <phpsyntax function="swf_actiongotolabel"></phpsyntax>
@@ -2452,10 +2452,10 @@ will return the original version.
         <phpsyntax function="tmpfile"></phpsyntax>
         <phpsyntax function="touch"></phpsyntax>
         <phpsyntax function="trigger_error"></phpsyntax>
-        <phpsyntax function="trim"></phpsyntax>
+        <phpsyntax function="trim" usage="string trim ( string str [, string charlist])">Strip whitespace from the beginning and end of a string </phpsyntax>
         <phpsyntax function="uasort" usage="void uasort ( array array, callback cmp_function)">Sort an array with a user-defined comparison function and maintain index association </phpsyntax>
-        <phpsyntax function="ucfirst"></phpsyntax>
-        <phpsyntax function="ucwords"></phpsyntax>
+        <phpsyntax function="ucfirst" usage="string ucfirst ( string str)">Make a string's first character uppercase</phpsyntax>
+        <phpsyntax function="ucwords" usage="string ucwords ( string str)">Uppercase the first character of each word in a string </phpsyntax>
         <phpsyntax function="udm_add_search_limit"></phpsyntax>
         <phpsyntax function="udm_alloc_agent"></phpsyntax>
         <phpsyntax function="udm_api_version"></phpsyntax>
@@ -2512,13 +2512,15 @@ will return the original version.
         <phpsyntax function="vpopmail_error"></phpsyntax>
         <phpsyntax function="vpopmail_passwd"></phpsyntax>
         <phpsyntax function="vpopmail_set_user_quota"></phpsyntax>
+        <phpsyntax function="vprintf" usage="void vprintf ( string format, array args)">Output a formatted string</phpsyntax>
+        <phpsyntax function="vsprintf" usage="string vsprintf ( string format, array args)">Output a formatted string</phpsyntax>
         <phpsyntax function="wddx_add_vars"></phpsyntax>
         <phpsyntax function="wddx_deserialize"></phpsyntax>
         <phpsyntax function="wddx_packet_end"></phpsyntax>
         <phpsyntax function="wddx_packet_start"></phpsyntax>
         <phpsyntax function="wddx_serialize_value"></phpsyntax>
         <phpsyntax function="wddx_serialize_vars"></phpsyntax>
-        <phpsyntax function="wordwrap"></phpsyntax>
+        <phpsyntax function="wordwrap" usage="string wordwrap ( string str [, int width [, string break [, int cut]]])">Wraps a string to a given number of characters using a string break character</phpsyntax>
         <phpsyntax function="write"></phpsyntax>
         <phpsyntax function="writev"></phpsyntax>
         <phpsyntax function="xml_error_string"></phpsyntax>