svn: /phpdoc/en/trunk/reference/filesystem/functions/ fileperms.xml
| From: | Adam Harvey | Date: | Mon, 30 Jan 2012 14:19:05 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/filesystem/functions/ fileperms.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-9523@lists.php.net to get a copy of this message | ||
aharvey Mon, 30 Jan 2012 14:19:05 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=322937
Log:
Re-fix doc bug #55775 (fileperms() return value not documented on success).
Bug: https://bugs.php.net/55775 (Assigned) fileperms()
return value not documented on success
Changed paths:
U phpdoc/en/trunk/reference/filesystem/functions/fileperms.xml
Modified: phpdoc/en/trunk/reference/filesystem/functions/fileperms.xml
===================================================================
--- phpdoc/en/trunk/reference/filesystem/functions/fileperms.xml 2012-01-30 14:09:42 UTC (rev
322936)
+++ phpdoc/en/trunk/reference/filesystem/functions/fileperms.xml 2012-01-30 14:19:05 UTC (rev
322937)
@@ -36,9 +36,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the file's permissions as a numeric mode of the same format as that
- expected by <function>chmod</function>, &return.falseforfailure;.
+ Returns the file's permissions as a numeric mode. Lower bits of this mode
+ are the same as the permissions expected by <function>chmod</function>,
+ however on most platforms the return value will also include information on
+ the type of file given as <parameter>filename</parameter>. The examples
+ below demonstrate how to test the return value for specific permissions and
+ file types on POSIX systems, including Linux and Mac OS X.
</para>
+ <para>
+ For local files, the specific return value is that of the
+ <literal>st_mode</literal> member of the structure returned by the C
+ library's <function>stat</function> function. Exactly which bits are set
+ can vary from platform to platform, and looking up your specific platform's
+ documentation is recommended if parsing the non-permission bits of the
+ return value is required.
+ </para>
</refsect1>
<refsect1 role="examples">