php-doc-en/reference/filesystem/functions/fileatime.xml
Adam Harvey 44aabb8f7e Move the "emits E_WARNING" paragraph for functions that do so when an internal
stat() fails to an entity, as suggested by Hannes.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@306338 c90b9560-bf6c-de11-be94-00142212c4b1
2010-12-13 09:04:07 +00:00

124 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fileatime">
<refnamediv>
<refname>fileatime</refname>
<refpurpose>Gets last access time of file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fileatime</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<simpara>
Gets the last access time of the given file.
</simpara>
</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>
Returns the time the file was last accessed, &return.falseforfailure;.
The time is returned as a Unix timestamp.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fileatime</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// outputs e.g. somefile.txt was last accessed: December 29 2002 22:16:23.
$filename = 'somefile.txt';
if (file_exists($filename)) {
echo "$filename was last accessed: " . date("F d Y H:i:s.", fileatime($filename));
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&fs.emits.warning.on.failure;
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
The atime of a file is supposed to change whenever the data blocks of a
file are being read. This can be costly performance-wise when an
application regularly accesses a very large number of files or
directories.
</para>
<para>
Some Unix filesystems can be mounted with atime updates disabled to
increase the performance of such applications; USENET news spools are a
common example. On such filesystems this function will be useless.
</para>
</note>
&note.filesystem-time-res;
&note.clearstatcache;
&tip.fopen-wrapper.stat;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>filemtime</function></member>
<member><function>fileinode</function></member>
<member><function>date</function></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
-->