Added some function documentation (explode, rege, eregi,...)
authorkhartlage <khartlage>
Thu, 11 Sep 2003 18:48:22 +0000 (18:48 +0000)
committerkhartlage <khartlage>
Thu, 11 Sep 2003 18:48:22 +0000 (18:48 +0000)
net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpsyntax.xml

index c952eaa..a91a0ee 100644 (file)
@@ -399,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>
@@ -410,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>
@@ -492,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>
@@ -680,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>
@@ -1226,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>
@@ -1888,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>
@@ -2082,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>