stat.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stat" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stat</refname>
  <refpurpose>Gives information about a file</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></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.
   Prior to PHP 7.4.0, on Windows <abbrev>NTS</abbrev> builds the <literal>size</literal>,
   <literal>atime</literal>, <literal>mtime</literal> and <literal>ctime</literal>
   statistics have been from the symlink, in this case.
  </para>
  <para>
   <function>lstat</function> is identical to <function>stat</function>
   except it would instead be based off the symlinks status.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Path to the file.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <table>
    <title><function>stat</function> and <function>fstat</function> result
     format</title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>Numeric</entry>
       <entry>Associative</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>0</entry>
       <entry>dev</entry>
       <entry>device number ***</entry>
      </row>
      <row>
       <entry>1</entry>
       <entry>ino</entry>
       <entry>inode number ****</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>mode</entry>
       <entry>inode protection mode *****</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>nlink</entry>
       <entry>number of links</entry>
      </row>
      <row>
       <entry>4</entry>
       <entry>uid</entry>
       <entry>userid of owner *</entry>
      </row>
      <row>
       <entry>5</entry>
       <entry>gid</entry>
       <entry>groupid of owner *</entry>
      </row>
      <row>
       <entry>6</entry>
       <entry>rdev</entry>
       <entry>device type, if inode device</entry>
      </row>
      <row>
       <entry>7</entry>
       <entry>size</entry>
       <entry>size in bytes</entry>
      </row>
      <row>
       <entry>8</entry>
       <entry>atime</entry>
       <entry>time of last access (Unix timestamp)</entry>
      </row>
      <row>
       <entry>9</entry>
       <entry>mtime</entry>
       <entry>time of last modification (Unix timestamp)</entry>
      </row>
      <row>
       <entry>10</entry>
       <entry>ctime</entry>
       <entry>time of last inode change (Unix timestamp)</entry>
      </row>
      <row>
       <entry>11</entry>
       <entry>blksize</entry>
       <entry>blocksize of filesystem IO **</entry>
      </row>
      <row>
       <entry>12</entry>
       <entry>blocks</entry>
       <entry>number of 512-byte blocks allocated **</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   * On Windows this will always be <literal>0</literal>.
  </para>
  <para>
   ** Only valid on systems supporting the st_blksize type - other
   systems (e.g. Windows) return <literal>-1</literal>.
  </para>
  <para>
   *** On Windows, as of PHP 7.4.0, this is the serial number of the volume that contains the file,
   which is a 64-bit <emphasis>unsigned</emphasis> integer, so may overflow.
   Previously, it was the numeric representation of the drive letter (e.g. <literal>2</literal>
   for <literal>C:</literal>) for <function>stat</function>, and <literal>0</literal> for
   <function>lstat</function>.
  </para>
  <para>
   **** On Windows, as of PHP 7.4.0, this is the identifier associated with the file,
   which is a 64-bit <emphasis>unsigned</emphasis> integer, so may overflow.
   Previously, it was always <literal>0</literal>.
  </para>
  <para>
   ***** On Windows, the writable permission bit is set according to the read-only
   file attribute, and the same value is reported for all users, group and owner.
   The ACL is not taken into account, contrary to <function>is_writable</function>.
  </para>
  <para>
  The value of <literal>mode</literal> contains information read by several functions. 
  When written in octal, starting from the right, the first three digits are returned by
  <function>chmod</function>. The next digit is ignored by PHP. The next two digits indicate
  the file type:
   <table>
    <title><literal>mode</literal> file types</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry><literal>mode</literal> in octal</entry>
       <entry>Meaning</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>0140000</literal></entry>
       <entry>socket</entry>
      </row>
      <row>
       <entry><literal>0120000</literal></entry>
       <entry>link</entry>
      </row>
      <row>
       <entry><literal>0100000</literal></entry>
       <entry>regular file</entry>
      </row>
      <row>
       <entry><literal>0060000</literal></entry>
       <entry>block device</entry>
      </row>
      <row>
       <entry><literal>0040000</literal></entry>
       <entry>directory</entry>
      </row>
      <row>
       <entry><literal>0020000</literal></entry>
       <entry>character device</entry>
      </row>
      <row>
       <entry><literal>0010000</literal></entry>
       <entry>fifo</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
   So for example a regular file could be <literal>0100644</literal> and a directory could be
   <literal>0040755</literal>.
  </para>
  <para>
   In case of error, <function>stat</function> returns &false;.
  </para>
  &fs.file.32bit;
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Upon failure, an <constant>E_WARNING</constant> is emitted.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.4.0</entry>
      <entry>
       On Windows, the device number is now the serial number of the volume that
       contains the file, and the inode number is the identifier associated with the file.
      </entry>
     </row>
     <row>
      <entry>7.4.0</entry>
      <entry>
       The <literal>size</literal>, <literal>atime</literal>, <literal>mtime</literal> and
       <literal>ctime</literal> statistics of symlinks are always those of the target.
       This was previously not the case for <abbrev>NTS</abbrev> builds on Windows.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>stat</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* Get file stat */
$stat = stat('C:\php\php.exe');

/*
 * Print file access time, this is the same 
 * as calling fileatime()
 */
echo 'Access time: ' . $stat['atime'];

/*
 * Print file modification time, this is the 
 * same as calling filemtime()
 */
echo 'Modification time: ' . $stat['mtime'];

/* Print the device number */
echo 'Device number: ' . $stat['dev'];
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Using <function>stat</function> information together with <function>touch</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/* Get file stat */
$stat = stat('C:\php\php.exe');

/* Did we failed to get stat information? */
if (!$stat) {
    echo 'stat() call failed...';
} else {
    /*
     * We want the access time to be 1 week 
     * after the current access time.
     */
    $atime = $stat['atime'] + 604800;

    /* Touch the file */
    if (!touch('some_file.txt', time(), $atime)) {
        echo 'Failed to touch file...';
    } else {
        echo 'touch() returned success...';
    }
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.filesystem-time-res;
  &note.clearstatcache;
  &tip.fopen-wrapper.stat;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>lstat</function></member>
    <member><function>fstat</function></member>
    <member><function>filemtime</function></member>
    <member><function>filegroup</function></member>
    <member><classname>SplFileInfo</classname></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->