touch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.touch">
 <refnamediv>
  <refname>touch</refname>
  <refpurpose>Sets access and modification time of file</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>touch</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>mtime</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>atime</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Attempts to set the access and modification times of the file named in the
   <parameter>filename</parameter> parameter to the value given in
   <parameter>mtime</parameter>. 
   Note that the access time is always modified, regardless of the number
   of parameters.
  </para>
  <para>
   If the file does not exist, it will be created. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       The name of the file being touched.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mtime</parameter></term>
     <listitem>
      <para>
       The touch time. If <parameter>mtime</parameter> is &null;, 
       the current system <function>time</function> is used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>atime</parameter></term>
     <listitem>
      <para>
       If not &null;, the access time of the given filename is set to
       the value of <parameter>atime</parameter>. Otherwise, it is set to
       the value passed to the <parameter>mtime</parameter> parameter.
       If both are &null;, the current system time is used.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>mtime</parameter> and <parameter>atime</parameter>
       are now nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>touch</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
if (touch($filename)) {
    echo $filename . ' modification time has been changed to present time';
} else {
    echo 'Sorry, could not change modification time of ' . $filename;
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>touch</function> using the <parameter>mtime</parameter> parameter</title>
    <programlisting role="php">
<![CDATA[
<?php
// This is the touch time, we'll set it to one hour in the past.
$time = time() - 3600;

// Touch the file
if (!touch('some_file.txt', $time)) {
    echo 'Whoops, something went wrong...';
} else {
    echo 'Touched file with success';
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.filesystem-time-res;
 </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
-->