new icons
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpsyntax.xml
index 175249e..a91a0ee 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>
@@ -88,24 +94,38 @@ about the given resource and returns this information in a class.
         <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"></phpsyntax>
-        <phpsyntax function="bcsqrt"></phpsyntax>
-        <phpsyntax function="bcsub"></phpsyntax>
-        <phpsyntax function="bin2hex"></phpsyntax>
-        <phpsyntax function="bind"></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="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="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>
@@ -379,10 +399,25 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="easter_date"></phpsyntax>
         <phpsyntax function="easter_days"></phpsyntax>
         <phpsyntax function="end"></phpsyntax>
-        <phpsyntax function="ereg"></phpsyntax>
+        <phpsyntax function="ereg" usage="int ereg ( string pattern, string string [, array regs])">Note: preg_match(), which uses a Perl-compatible regular expression syntax, is often a faster alternative to ereg(). 
+Searches a string for matches to the regular expression given in pattern. 
+If matches are found for parenthesized substrings of pattern and the function is called with the third argument regs, 
+the matches will be stored in the elements of the array regs. 
+$regs[1] will contain the substring which starts at the first left parenthesis; 
+$regs[2] will contain the substring starting at the second, and so on. 
+$regs[0] will contain a copy of the complete string matched. 
+Note: Up to (and including) PHP 4.1.0 $regs will be filled with exactly ten elements, 
+even though more or fewer than ten parenthesized substrings may actually have matched. 
+This has no effect on ereg()'s ability to match more substrings. 
+If no matches are found, $regs will not be altered by ereg(). 
+Searching is case sensitive. 
+Returns TRUE if a match for pattern was found in string, or FALSE if no matches were found or an error occurred. 
+        </phpsyntax>
         <phpsyntax function="ereg_replace"></phpsyntax>
-        <phpsyntax function="eregi"></phpsyntax>
-        <phpsyntax function="eregi_replace"></phpsyntax>
+        <phpsyntax function="eregi" usage="int eregi ( string pattern, string string [, array regs])">This function is identical to ereg() except that this ignores case distinction when matching alphabetic characters.
+        </phpsyntax>
+        <phpsyntax function="eregi_replace" usage="string eregi_replace ( string pattern, string replacement, string string)"></phpsyntax>replace regular expression case insensitive
+This function is identical to ereg_replace() except that this ignores case distinction when matching alphabetic characters. 
         <phpsyntax function="error_log"></phpsyntax>
         <phpsyntax function="error_reporting"></phpsyntax>
         <phpsyntax function="escapeshellarg"></phpsyntax>
@@ -390,7 +425,12 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="exec"></phpsyntax>
         <phpsyntax function="exit"></phpsyntax>
         <phpsyntax function="exp"></phpsyntax>
-        <phpsyntax function="explode"></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, 
+then explode() will return an array containing string. 
+Note: The limit parameter was added in PHP 4.0.1 
+        </phpsyntax>
         <phpsyntax function="extension_loaded"></phpsyntax>
         <phpsyntax function="extract"></phpsyntax>
         <phpsyntax function="ezmlm_hash"></phpsyntax>
@@ -472,7 +512,12 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="fgets"></phpsyntax>
         <phpsyntax function="fgetss"></phpsyntax>
         <phpsyntax function="file"></phpsyntax>
-        <phpsyntax function="file_exists"></phpsyntax>
+        <phpsyntax function="file_exists" usage="bool file_exists ( string filename)">Checks whether a file exists
+Returns TRUE if the file specified by filename exists; FALSE otherwise. 
+This function will not work on remote files; the file to be examined must be accessible via the server's filesystem. 
+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="fileatime"></phpsyntax>
         <phpsyntax function="filectime"></phpsyntax>
         <phpsyntax function="filegroup"></phpsyntax>
@@ -660,7 +705,19 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="gztell"></phpsyntax>
         <phpsyntax function="gzuncompress"></phpsyntax>
         <phpsyntax function="gzwrite"></phpsyntax>
-        <phpsyntax function="header"></phpsyntax>
+        <phpsyntax function="header" usage="int header ( string string [, bool replace [, int http_reponse_code]])">Send a raw HTTP header
+header() is used to send raw HTTP headers. See the HTTP/1.1 specification for more information on HTTP headers. 
+The optional replace parameter indicates whether the header should replace a previous similar header, 
+or add a second header of the same type. 
+By default it will replace, but if you pass in FALSE as the second argument you can force multiple headers of the same type. 
+
+The second optional http_response_code force the HTTP response code to the specified value. 
+(This parameter is available in PHP 4.3.0 and higher.) 
+There are two special-case header calls. The first is a header that starts with the string &quot;HTTP/&quot; (case is not significant), 
+which will be used to figure out the HTTP status code to send. For example, 
+if you have configured Apache to use a PHP script to handle requests for missing files 
+(using the ErrorDocument directive), you may want to make sure that your script generates the proper status code. 
+        </phpsyntax>
         <phpsyntax function="headers_sent"></phpsyntax>
         <phpsyntax function="hebrev"></phpsyntax>
         <phpsyntax function="hebrevc"></phpsyntax>
@@ -1206,7 +1263,12 @@ Directory class with properties, handle and class and methods read, rewind and c
         <phpsyntax function="mhash_get_block_size"></phpsyntax>
         <phpsyntax function="mhash_get_hash_name"></phpsyntax>
         <phpsyntax function="mhash_keygen_s2k"></phpsyntax>
-        <phpsyntax function="microtime"></phpsyntax>
+        <phpsyntax function="microtime" usage="string microtime (void)">Return current UNIX timestamp with microseconds
+Returns the string &quot;msec sec&quot; where sec is the current time measured in the number of seconds
+since the Unix Epoch (0:00:00 January 1, 1970 GMT), and msec is the microseconds part. 
+This function is only available on operating systems that support the gettimeofday() system call. 
+Both portions of the string are returned in units of seconds. 
+        </phpsyntax>
         <phpsyntax function="min"></phpsyntax>
         <phpsyntax function="ming_setcubicthreshold"></phpsyntax>
         <phpsyntax function="ming_setscale"></phpsyntax>
@@ -1868,7 +1930,9 @@ See also mysql_query() for the counterpart of this behaviour.
         <phpsyntax function="php_uname"></phpsyntax>
         <phpsyntax function="phpcredits"></phpsyntax>
         <phpsyntax function="phpinfo"></phpsyntax>
-        <phpsyntax function="phpversion"></phpsyntax>
+        <phpsyntax function="phpversion"  usage="string phpversion (void)">Returns a string containing the version of the currently running PHP parser.
+Note: This information is also available in the predefined constant PHP_VERSION. 
+        </phpsyntax>
         <phpsyntax function="pi"></phpsyntax>
         <phpsyntax function="png2wbmp"></phpsyntax>
         <phpsyntax function="popen"></phpsyntax>
@@ -2062,7 +2126,19 @@ See also mysql_query() for the counterpart of this behaviour.
         <phpsyntax function="setbounds"></phpsyntax>
         <phpsyntax function="setcolor"></phpsyntax>
         <phpsyntax function="setcolor"></phpsyntax>
-        <phpsyntax function="setcookie"></phpsyntax>
+        <phpsyntax function="setcookie" usage="boolean setcookie ( string name [, string value [, int expire [, string path [, string domain [, int secure]]]]])">Send a cookie
+setcookie() defines a cookie to be sent along with the rest of the HTTP headers. 
+Like other headers, cookies must be sent before any output from your script (this is a protocol restriction). 
+This requires that you place calls to this function prior to any output, including &lt;html&gt; and &lt;head&gt; tags as well as any whitespace.
+If output exists prior to calling this function, setcookie() will fail and return FALSE. 
+If setcookie() successfully runs, it will return TRUE. 
+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. 
+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>
         <phpsyntax function="setdimension"></phpsyntax>
         <phpsyntax function="setdown"></phpsyntax>