From 891ea0a06ef0e6e0d95c8975fa4b698c5f7325e9 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Fri, 15 Jun 2007 19:45:56 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237787 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/filesystem/functions/feof.xml | 44 ++--- .../filesystem/functions/file-exists.xml | 4 +- .../functions/file-get-contents.xml | 187 +++++++++--------- .../functions/file-put-contents.xml | 6 +- reference/filesystem/functions/filectime.xml | 5 +- reference/filesystem/functions/flock.xml | 28 +-- .../filesystem/functions/is-readable.xml | 4 +- .../filesystem/functions/is-uploaded-file.xml | 6 +- reference/filesystem/functions/readlink.xml | 16 +- 9 files changed, 151 insertions(+), 149 deletions(-) diff --git a/reference/filesystem/functions/feof.xml b/reference/filesystem/functions/feof.xml index 3f7560d228..c68d372d19 100644 --- a/reference/filesystem/functions/feof.xml +++ b/reference/filesystem/functions/feof.xml @@ -1,5 +1,5 @@ - + @@ -16,23 +16,23 @@ Returns &true; if the file pointer is at EOF or an error occurs (including socket timeout); otherwise returns &false;. - - - If a connection opened by fsockopen wasn't closed - by the server, feof will wait until a timeout has - been reached to return &true;. The default timeout value is 60 seconds. - You may use stream_set_timeout to change this - value. - - - &fs.validfp.all; - - - If passed file pointer is not valid you may get an infinite loop, because - EOF fails to return TRUE. - - <function>feof</function> example with an invalid file pointer - + + + If a connection opened by fsockopen wasn't closed + by the server, feof will wait until a timeout has + been reached to return &true;. The default timeout value is 60 seconds. + You may use stream_set_timeout to change this + value. + + + &fs.validfp.all; + + + If passed file pointer is not valid you may get an infinite loop, because + EOF fails to return TRUE. + + <function>feof</function> example with an invalid file pointer + ]]> - - - - + + + + diff --git a/reference/filesystem/functions/file-exists.xml b/reference/filesystem/functions/file-exists.xml index b3ffc9dbf0..1e3e01e18a 100644 --- a/reference/filesystem/functions/file-exists.xml +++ b/reference/filesystem/functions/file-exists.xml @@ -1,5 +1,5 @@ - + @@ -53,7 +53,7 @@ if (file_exists($filename)) { linkend="ini.safe-mode-include-dir">safe_mode_include_dir. - + The check is done using the real UID/GID instead of the effective one. diff --git a/reference/filesystem/functions/file-get-contents.xml b/reference/filesystem/functions/file-get-contents.xml index 143fcae9de..2100307eb1 100644 --- a/reference/filesystem/functions/file-get-contents.xml +++ b/reference/filesystem/functions/file-get-contents.xml @@ -1,100 +1,101 @@ - - - - - file_get_contents - Reads entire file into a string - - - &reftitle.description; - - stringfile_get_contents - stringfilename - booluse_include_path - resourcecontext - intoffset - intmaxlen - - - Identical to file, except that - file_get_contents returns the file in a string, - starting at the specified offset up to - maxlen bytes. - 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. - - - - If you're opening a URI with special characters, such as spaces, you - need to encode the URI with urlencode. - - - - - context parameter can be skipped by &null;. - - - + + + + file_get_contents + Reads entire file into a string + - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.0 - - Added the context support. - - - - 5.1.0 - - Added the offset and - maxlen parameters. - - - - - - - + + &reftitle.description; + + stringfile_get_contents + stringfilename + booluse_include_path + resourcecontext + intoffset + intmaxlen + + + Identical to file, except that + file_get_contents returns the file in a string, + starting at the specified offset up to + maxlen bytes. + 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. + + + + If you're opening a URI with special characters, such as spaces, you + need to encode the URI with urlencode. + + + + + context parameter can be skipped by &null;. + + + - - &reftitle.notes; - ¬e.bin-safe; - &tip.fopen-wrapper; - ¬e.context-support; - &warn.ssl-non-standard; - + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 5.0.0 + + Added the context support. + + + + 5.1.0 + + Added the offset and + maxlen parameters. + + + + + + + - - &reftitle.seealso; - - - file - fgets - fread - readfile - file_put_contents - stream_get_contents - stream_context_create - - - - + + &reftitle.notes; + ¬e.bin-safe; + &tip.fopen-wrapper; + ¬e.context-support; + &warn.ssl-non-standard; + + + + &reftitle.seealso; + + + file + fgets + fread + readfile + file_put_contents + stream_get_contents + stream_context_create + + + + + + file_put_contents Write a string to a file + &reftitle.description; @@ -127,7 +128,6 @@ - &reftitle.notes; ¬e.bin-safe; @@ -135,7 +135,6 @@ &tip.fopen-wrapper; - &reftitle.seealso; @@ -147,6 +146,7 @@ + + @@ -25,7 +25,8 @@ when you want to create "Last Modified" footers on web pages) and fileatime. - Note also that in some Unix texts the ctime of a file is + + Note also that in some Unix texts the ctime of a file is referred to as being the creation time of the file. This is wrong. There is no creation time for Unix files in most Unix filesystems. diff --git a/reference/filesystem/functions/flock.xml b/reference/filesystem/functions/flock.xml index 4749d461a0..6b55678cbe 100644 --- a/reference/filesystem/functions/flock.xml +++ b/reference/filesystem/functions/flock.xml @@ -1,5 +1,5 @@ - + @@ -34,30 +34,30 @@ - To acquire a shared lock (reader), set - operation to LOCK_SH (set to 1 prior to - PHP 4.0.1). + To acquire a shared lock (reader), set + operation to LOCK_SH (set to 1 prior to + PHP 4.0.1). - To acquire an exclusive lock (writer), set - operation to LOCK_EX (set to 2 prior to - PHP 4.0.1). + To acquire an exclusive lock (writer), set + operation to LOCK_EX (set to 2 prior to + PHP 4.0.1). - To release a lock (shared or exclusive), set - operation to LOCK_UN (set to 3 prior to - PHP 4.0.1). + To release a lock (shared or exclusive), set + operation to LOCK_UN (set to 3 prior to + PHP 4.0.1). - If you don't want flock to block while - locking, add LOCK_NB (4 prior to PHP 4.0.1) to - operation. + If you don't want flock to block while + locking, add LOCK_NB (4 prior to PHP 4.0.1) to + operation. @@ -71,7 +71,7 @@ (which is also called automatically when script finished). - &return.success; + &return.success; diff --git a/reference/filesystem/functions/is-readable.xml b/reference/filesystem/functions/is-readable.xml index ac536b174f..f936cbc8e3 100644 --- a/reference/filesystem/functions/is-readable.xml +++ b/reference/filesystem/functions/is-readable.xml @@ -1,5 +1,5 @@ - + @@ -48,7 +48,7 @@ if (is_readable($filename)) { The check is done using the real UID/GID instead of the effective one. - + See also is_writable, file_exists, and diff --git a/reference/filesystem/functions/is-uploaded-file.xml b/reference/filesystem/functions/is-uploaded-file.xml index 7cdcffaf4b..de38c8fce7 100644 --- a/reference/filesystem/functions/is-uploaded-file.xml +++ b/reference/filesystem/functions/is-uploaded-file.xml @@ -1,5 +1,5 @@ - + @@ -61,8 +61,8 @@ if (is_uploaded_file($_FILES['userfile']['tmp_name'])) { - - <function>is_uploaded_file</function> example for PHP 4 < 4.0.3 + + <function>is_uploaded_file</function> example for PHP 4 < 4.0.3 - + @@ -13,14 +13,14 @@ stringpath - readlink does the same as the readlink C - function and returns the contents of the symbolic link path or &false; - in case of error. + readlink does the same as the readlink C + function and returns the contents of the symbolic link path or &false; + in case of error. - - - <function>readlink</function> example - + + + <function>readlink</function> example +