Extended the builder with an index file generator for PHP class- and function-names.
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpsyntax.xml
index 28d927f..c952eaa 100644 (file)
@@ -7,7 +7,7 @@
         <phpsyntax function="COM_invoke" usage="mixed COM_invoke(int module, string handler_name [, mixed arg [, mixed ...]])">Invokes a COM module</phpsyntax>
         <phpsyntax function="COM_load" usage="int com_load(string module_name [, string remote_host [, int codepage [, string typelib]]])">Loads a COM module</phpsyntax>
         <phpsyntax function="abs" usage="int abs(int number)">Return the absolute value of the number</phpsyntax>
-        <phpsyntax function="accept_connect"></phpsyntax>
+<phpsyntax function="accept_connect"></phpsyntax>
         <phpsyntax function="acos" usage="float acos(float arg)">Return the arc cosine of the arg in radians</phpsyntax>
         <phpsyntax function="acosh" usage="float acosh(float arg)">Returns the inverse hyperbolic cosine of arg</phpsyntax>
         <phpsyntax function="add"></phpsyntax>
@@ -20,7 +20,7 @@ It escapes \n, \r etc. in C-like style, characters with ASCII code lower than 32
 higher than 126 are converted to octal representation.</phpsyntax>
         <phpsyntax function="addentry"></phpsyntax>
         <phpsyntax function="addfill"></phpsyntax>
-        <phpsyntax function="addshape"></phpsyntax>
+        <phpsyntax function="addshape"></phpsyntax> 
         <phpsyntax function="addslashes" usage="string addslashes (string str)">
 Returns a string with backslashes before characters that need to be quoted in database queries etc. 
 These characters are single quote ('), double quote (&quot;), backslash (\) and NUL (the NULL byte).</phpsyntax>
@@ -40,7 +40,7 @@ back to the operating system.
 This performs a partial request for a URI. It goes just far enough to obtain all the important information 
 about the given resource and returns this information in a class.
         </phpsyntax>
-        <phpsyntax function="apache_note"></phpsyntax>
+        <phpsyntax function="apache_note" usage="string apache_note ( string note_name [, string note_value])">apache_note() is an Apache-specific function which gets and sets values in a request's notes table. If called with one argument, it returns the current value of note note_name. If called with two arguments, it sets the value of note note_name to note_value and returns the previous value of note note_name.</phpsyntax>
         <phpsyntax function="apache_sub_req"></phpsyntax>
         <phpsyntax function="array_count_values"></phpsyntax>
         <phpsyntax function="array_diff"></phpsyntax>
@@ -67,17 +67,23 @@ about the given resource and returns this information in a class.
         <phpsyntax function="array_unshift"></phpsyntax>
         <phpsyntax function="array_values"></phpsyntax>
         <phpsyntax function="array_walk"></phpsyntax>
-        <phpsyntax function="arsort"></phpsyntax>
-        <phpsyntax function="asin"></phpsyntax>
-        <phpsyntax function="asort"></phpsyntax>
-        <phpsyntax function="aspell_check"></phpsyntax>
-        <phpsyntax function="aspell_check_raw"></phpsyntax>
-        <phpsyntax function="aspell_new"></phpsyntax>
-        <phpsyntax function="aspell_suggest"></phpsyntax>
-        <phpsyntax function="assert"></phpsyntax>
-        <phpsyntax function="assert_options"></phpsyntax>
-        <phpsyntax function="atan"></phpsyntax>
-        <phpsyntax function="atan2"></phpsyntax>
+        <phpsyntax function="arsort" usage="void arsort ( array array [, int sort_flags])">This function sorts an array such that array indices maintain their correlation with the array elements they are associated with. This is used mainly when sorting associative arrays where the actual element order is significant.</phpsyntax>
+        <phpsyntax function="asin" usage="float asin ( float arg)">Returns the arc sine of arg in radians. asin() is the complementary function of sin(), which means that a==sin(asin(a)) for every value of a that is within asin() 's range.</phpsyntax>
+        <phpsyntax function="asort" usage="void asort ( array array [, int sort_flags])">This function sorts an array such that array indices maintain their correlation with the array elements they are associated with. This is used mainly when sorting associative arrays where the actual element order is significant.</phpsyntax>
+        <phpsyntax function="aspell_check" usage="bool aspell_check ( int dictionary_link, string word)">aspell_check() checks the spelling of a word and returns TRUE if the spelling is correct, FALSE if not.</phpsyntax>
+        <phpsyntax function="aspell_check_raw" usage="bool aspell_check_raw ( int dictionary_link, string word)">aspell_check_raw() checks the spelling of a word, without changing its case or trying to trim it in any way and returns TRUE if the spelling is correct, FALSE if not.</phpsyntax>
+        <phpsyntax function="aspell_new" usage="int aspell_new ( string master [, string personal])">aspell_new() opens up a new dictionary and returns the dictionary link identifier for use in other aspell functions. Returns FALSE on error.</phpsyntax>
+        <phpsyntax function="aspell_suggest" usage="array aspell_suggest ( int dictionary_link, string word)">aspell_suggest() returns an array of possible spellings for the given word.</phpsyntax>
+        <phpsyntax function="assert" usage="int assert ( mixed assertion)">
+assert() will check the given assertion and take appropriate action if its result is FALSE .
+
+If the assertion is given as a string it will be evaluated as PHP code by assert(). The advantages of a string assertion are less overhead when assertion checking is off and messages containing the assertion expression when an assertion fails. This means that if you pass a boolean condition as assertion this condition will not show up as parameter to the assertion function which you may have defined with the assert_options() function, the condition is converted to a string before calling that handler function, and the boolean FALSE is converted as the empty string.</phpsyntax>
+        <phpsyntax function="assert_options" usage="mixed assert_options ( int what [, mixed value])">Using assert_options() you may set the various assert() control options or just query their current settings.</phpsyntax>
+        <phpsyntax function="atan" usage="loat atan ( float arg)">Returns the arc tangent of arg in radians. atan() is the complementary function of tan(), which means that a==tan(atan(a)) for every value of a that is within atan()'s range.</phpsyntax>
+        <phpsyntax function="atan2" usage="float atan2 ( float y, float x)">
+This function calculates the arc tangent of the two variables xand y. It is similar to calculating the arc tangent of y/x, except that the signs of both arguments are used to determine the quadrant of the result. 
+
+The function returns the result in radians, which is between -PI and PI (inclusive)</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>
@@ -92,6 +98,8 @@ about the given resource and returns this information in a class.
         <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="bind"></phpsyntax>
+        <phpsyntax function="bindec"></phpsyntax>
         <phpsyntax function="bindec" usage="int bindec ( string binary_string)">
 Returns the decimal equivalent of the binary number represented by the binary_string argument.