php-doc-en/reference/filesystem/functions/touch.xml
Markus Fischer a55d376298 - Document third parameter
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@82120 c90b9560-bf6c-de11-be94-00142212c4b1
2002-05-13 18:39:48 +00:00

66 lines
2.1 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.touch">
<refnamediv>
<refname>touch</refname>
<refpurpose>Sets access and modification time of file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>touch</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>time</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>atime</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to set the access and modification time of the file named by
filename to the value given by time. If the option <parameter>time</parameter> is not
given, uses the present time. This is equivalent to what utime
(sometimes referred to as utimes) does. If the third option
<parameter>atime</parameter> is present, the access time of the given
filename is also modified.
</para>
<para>
If the file does not exist, it is created.
</para>
<para>
&return.success;
<example>
<title><function>touch</function> example</title>
<programlisting role="php">
<![CDATA[
if (touch ($FileName)) {
print "$FileName modification time has been
changed to todays date and time";
} else {
print "Sorry Could Not change modification time of $FileName";
}
]]>
</programlisting>
</example>
</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
-->