php-doc-en/reference/filesystem/functions/stat.xml
Philip Olson 5aa3b832c7 A global filesystem commit: Made use of entities note.no-remote and note.clearstatcache,
added <?php ?>, See also's, some example cleanup, and minor changes.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@117578 c90b9560-bf6c-de11-be94-00142212c4b1
2003-02-22 18:55:36 +00:00

79 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.stat">
<refnamediv>
<refname>stat</refname>
<refpurpose>Gives information about a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>stat</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Gathers the statistics of the file named by
<parameter>filename</parameter>. If <parameter>filename</parameter>
is a symbolic link, statistics are from the file itself, not the
symlink. <function>lstat</function> is identical to <function>
stat</function> except it would instead be based off the symlinks
status.
</para>
<para>
In case of error, <function>stat</function> returns &false;
</para>
<para>
Returns an array with the statistics of the file with the
following elements:
<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>
</orderedlist>
* - only valid on systems supporting the st_blksize type--other
systems (i.e. Windows) return -1.
</para>
&note.clearstatcache;
&note.no-remote;
<para>
See also <function>lstat</function>,
<function>filemtime</function>, and
<function>filegroup</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->