touch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2b56c905fb0d6fcab44cc0c2abdbf393fc2b69ea Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: Luffy -->
<refentry xml:id="function.touch" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>touch</refname>
  <refpurpose>设定文件的访问和修改时间</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>
   尝试将由 <parameter>filename</parameter>
   给出的文件的访问和修改时间设定为给出的 <parameter>mtime</parameter>。
   注意访问时间总是会被修改的，不论有几个参数。
  </para>
  <para>
   如果文件不存在，则会被创建。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       要设定的文件名。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mtime</parameter></term>
     <listitem>
      <para>
       要设定的时间。如果参数 <parameter>mtime</parameter> 为 &null;，则会使用当前系统的 <function>time</function>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>atime</parameter></term>
     <listitem>
      <para>
       如果这个参数不是 &null;，则给定文件的访问时间会被设为 <parameter>atime</parameter>。
       否则会设置为 <parameter>mtime</parameter>。
       如果两个参数都是 &null;，则使用当前系统时间。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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> 和 <parameter>atime</parameter>
       现在可以为空。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>touch</function> 例子</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>使用 <parameter>mtime</parameter> 参数的 <function>touch</function></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
-->