From fce226114f4dc99e99a5e08a5da3c6deaf85fb03 Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Sun, 31 Aug 2008 01:30:39 +0000
Subject: [PATCH] Added new example for touch() Added two examples for stat()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@265705 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/filesystem/functions/stat.xml  | 73 +++++++++++++++++++++++-
 reference/filesystem/functions/touch.xml | 35 +++++++++++-
 2 files changed, 106 insertions(+), 2 deletions(-)

diff --git a/reference/filesystem/functions/stat.xml b/reference/filesystem/functions/stat.xml
index edc4968b27..44e02702ca 100644
--- a/reference/filesystem/functions/stat.xml
+++ b/reference/filesystem/functions/stat.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.22 $ -->
+<!-- $Revision: 1.23 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.stat">
  <refnamediv>
   <refname>stat</refname>
@@ -166,6 +166,77 @@
   </para>
  </refsect1>
 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>stat</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+/* Get file stat */
+$stat = stat('C:\php\php.exe');
+
+/*
+ * Print file access file, this is the same 
+ * as calling fileatime()
+ */
+echo 'Access time: ' . $stat['atime'];
+
+/*
+ * Print file modification time, this is the 
+ * same as calling filemtime()
+ */
+echo 'Modification time: ' . $stat['mtime'];
+
+/* Print the device number */
+echo 'Device number: ' . $stat['dev'];
+]]>
+    </programlisting>
+   </example>
+  </para>
+  <para>
+   <example>
+    <title>Using <function>stat</function> information together with <function>touch</function></title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+/* Get file stat */
+$stat = @stat('C:\php\php.exe');
+
+/* Did we failed to get stat information ? */
+if(!$stat)
+{
+     die('Stat call failed, aborting...');
+}
+
+/*
+ * Like in the example for touch() we'll need to 
+ * set the timezone to prevent E_STRICT errors in 
+ * PHP 5.1+
+ */
+if(function_exists('date_default_timezone_set'))
+{
+    date_default_timezone_set('UTC');
+}
+
+/* We want the access time to be 1 week ago */
+$atime = $stat['atime'] + 604800;
+
+/* Touch the file */
+if(!@touch('some_file.txt', time(), $atime))
+{
+    die('Failed to touch file...');
+}
+
+echo 'Touch returned success...';
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.filesystem-time-res;
diff --git a/reference/filesystem/functions/touch.xml b/reference/filesystem/functions/touch.xml
index 151355864c..88b788d4f3 100644
--- a/reference/filesystem/functions/touch.xml
+++ b/reference/filesystem/functions/touch.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.18 $ -->
+<!-- $Revision: 1.19 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.touch">
  <refnamediv>
   <refname>touch</refname>
@@ -106,6 +106,39 @@ if (touch($FileName)) {
     echo "Sorry, could not change modification time of $FileName";
 }
 ?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+  <para>
+   <example>
+    <title><function>touch</function> using the <parameter>time</parameter> parameter</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+/* 
+ * First set the time zone if PHP 5.1+, this will 
+ * prevent any E_STRICT errors.
+ */
+if(function_exists('date_default_timezone_set'))
+{
+    date_default_timezone_set('UTC');
+}
+
+/* 
+ * Next 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))
+{
+    die('Whoops, something went wrong...');
+}
+
+echo 'Touched file with success';
+?>
 ]]>
     </programlisting>
    </example>