File: touch.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (74 lines) | stat: -rw-r--r-- 2,367 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- 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>bool</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 times of the file named in the
     <parameter>filename</parameter> parameter to the value given in
     <parameter>time</parameter>. If <parameter>time</parameter>
     is not supplied, the current system time is used. If the third parameter,
     is present, the access time of the given
     filename is set to the value of <parameter>atime</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. &return.success;
    </para>
    <warning>
     <para>
      It is not currently possible to change the modification time of a
      directory with this function under Windows.
     </para>
    </warning>
    <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>
   </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
-->