archived-doc-fr/reference/filesystem/functions/touch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2b56c905fb0d6fcab44cc0c2abdbf393fc2b69ea Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.touch">
 <refnamediv>
  <refname>touch</refname>
  <refpurpose>Modifie la date de modification et de dernier accès d'un fichier</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>
   Tente de forcer la date de modification du fichier
   désigné par le paramètre <parameter>filename</parameter> à la date
   spécifiée par le paramètre <parameter>mtime</parameter>.
   Il est à noter que la date de dernier accès est modifiée, quel que
   soit le nombre de paramètres.
  </para>
  <para>
   Si le fichier n'existe pas, PHP tentera de le créer.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Le nom du fichier à créer.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mtime</parameter></term>
     <listitem>
      <para>
       La date de création. Si <parameter>mtime</parameter> est omis,
       c'est l'heure courante <function>time</function> qui est utilisée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>atime</parameter></term>
     <listitem>
      <para>
       Si non &null;, l'heure d'accès au fichier fourni sera défini à la valeur
       du paramètre <parameter>atime</parameter>. Sinon, elle sera définie à
       la valeur passée au paramètre <parameter>mtime</parameter>.
       Si tous les deux sont &null;, l'heure courante du système sera utilisée.
      </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> et <parameter>atime</parameter>
       sont désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>touch</function></title>
    <programlisting role="php">
<![CDATA[
<?php
if (touch($FileName)) {
    echo "La date de modification de $FileName a été modifiée à la date courante";
} else {
    echo "Désolé, il est impossible de changer la date de modification de $FileName";
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <function>touch</function> en utilisant le paramètre
    <parameter>mtime</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
/*
 * Ceci est la date et l'heure du dernier accès, nous y ajoutons 1 heure
 * dans le passé.
 */
$time = time() - 3600;

/* Touchons le fichier ! */
if (!touch('some_file.txt', $time)) {
    echo 'Whoops, une erreur est survenue...';
} else {
    echo 'L\'appel à la fonction touch() a réussi';
}
?>
]]>
    </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
-->