cvs: phpdoc /en/reference/filesystem/functions stat.xml

alindeman Fri May 9 17:42:28 2003 EDT Modified files: /phpdoc/en/reference/filesystem/functions stat.xml Log: implementation of user notes, as in bug #23568 Index: phpdoc/en/reference/filesystem/functions/stat.xml diff -u phpdoc/en/reference/filesystem/functions/stat.xml:1.3 phpdoc/en/reference/filesystem/functions/stat.xml:1.4 --- phpdoc/en/reference/filesystem/functions/stat.xml:1.3 Sat Feb 22 13:55:36 2003 +++ phpdoc/en/reference/filesystem/functions/stat.xml Fri May 9 17:42:28 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.stat"> <refnamediv> @@ -21,25 +21,85 @@ status. </para> <para> - In case of error, <function>stat</function> returns &false; + In case of error, <function>stat</function> returns &false;. It also + will throw a warning. </para> <para> Returns an array with the statistics of the file with the - following elements: + following elements. This array is zero-based. In addition to + returning these attributes in a numeric array, they can be accessed + with associative indices, as noted next to each parameter; this is + available since PHP 4.0.6: <orderedlist> - <listitem><simpara>device</simpara></listitem> - <listitem><simpara>inode</simpara></listitem> - <listitem><simpara>inode protection mode</simpara></listitem> - <listitem><simpara>number of links</simpara></listitem> - <listitem><simpara>user id of owner</simpara></listitem> - <listitem><simpara>group id owner</simpara></listitem> - <listitem><simpara>device type if inode device *</simpara></listitem> - <listitem><simpara>size in bytes</simpara></listitem> - <listitem><simpara>time of last access</simpara></listitem> - <listitem><simpara>time of last modification</simpara></listitem> - <listitem><simpara>time of last change</simpara></listitem> - <listitem><simpara>blocksize for filesystem I/O *</simpara></listitem> - <listitem><simpara>number of blocks allocated</simpara></listitem> + <listitem> + <simpara> + device (can also be accessed as <literal>dev</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + inode (can also be accessed as <literal>ino</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + inode protection mode (can also be accessed as <literal>mode</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + number of links (can also be accessed as <literal>nlink</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + user id of owner (can also be accessed as <literal>uid</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + group id owner (can also be accessed as <literal>gid</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + device type if inode device (can also be accessed as <literal>rdev + </literal>) * + </simpara> + </listitem> + <listitem> + <simpara> + size in bytes (can also be accessed as <literal>size</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + time of last access (can also be accessed as <literal>atime</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + time of last modification (can also be accessed as <literal>mtime + </literal>) + </simpara> + </listitem> + <listitem> + <simpara> + time of last change (can also be accessed as <literal>ctime</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + blocksize for filesystem I/O * (can also be accessed as + <literal>blksize</literal>) + </simpara> + </listitem> + <listitem> + <simpara> + number of blocks allocated (can also be accessed as + <literal>blocks</literal>) + </simpara> + </listitem> </orderedlist> * - only valid on systems supporting the st_blksize type--other systems (i.e. Windows) return -1.