touch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2b56c905fb0d6fcab44cc0c2abdbf393fc2b69ea Maintainer: wiesemann Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 2b56c905fb0d6fcab44cc0c2abdbf393fc2b69ea Reviewer: samesch -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.touch">
 <refnamediv>
  <refname>touch</refname>
  <refpurpose>Setzt die Zugriffs- und Modifikationszeit einer Datei</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>
   Versucht, die Zugriffs- und Modifikationszeit der im Parameter
   <parameter>filename</parameter> angegebenen Datei auf
   <parameter>mtime</parameter> zu setzen. Zu beachten ist, dass die
   Zugriffszeit unabhängig von der Anzahl der Parameter immer geändert wird.
  </para>
  <para>
   Wenn die Datei nicht existiert, wird sie erzeugt.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Der Name der zu ändernden Datei.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mtime</parameter></term>
     <listitem>
      <para>
       Die Modifikationszeit. Wenn <parameter>mtime</parameter> &null; ist,
       wird die aktuelle Systemzeit (<function>time</function>) verwendet.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>atime</parameter></term>
     <listitem>
      <para>
       Wenn nicht &null;, wird die Zugriffszeit der angegebenen Datei auf
       <parameter>atime</parameter> gesetzt. Andernfalls wird sie auf den
       Wert des angegebenen Parameters <parameter>mtime</parameter> gesetzt.
       Wenn beide &null; sind, wird die aktuelle Systemzeit verwendet.
      </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> und <parameter>atime</parameter>
       sind jetzt nullbar.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>touch</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
if (touch($filename)) {
    echo 'Die Modifikationszeit von ' . $filename
         . ' wurde auf die aktuelle Zeit gesetzt.';
} else {
    echo 'Entschuldigung, die Änderung der Modifikationszeit von ' . $filename
         . ' war nicht möglich.';
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Nutzung von <function>touch</function> mit dem Parameter <parameter>mtime</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
// Modifikationszeit (eine Stunde in der Vergangenheit)
$time = time() - 3600;

// Ändern der Datei
if (!touch('eine_datei.txt', $time)) {
    echo 'Ein Fehler ist aufgetreten ...';
} else {
    echo 'Änderung der Modifikationszeit war erfolgreich';
}
?>
]]>
    </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
-->