From 4c39c0fb734f594e1bd5fe16ceeb7e5008dec348 Mon Sep 17 00:00:00 2001
From: Adam Harvey <aharvey@php.net>
Date: Wed, 13 Oct 2010 08:58:01 +0000
Subject: [PATCH] Fix doc bug #53046 (doc error) by adding an Errors/Exception
 section to all the functions that call stat() internally.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@304365 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/filesystem/functions/file-exists.xml   | 7 +++++++
 reference/filesystem/functions/fileatime.xml     | 7 +++++++
 reference/filesystem/functions/filectime.xml     | 7 +++++++
 reference/filesystem/functions/fileinode.xml     | 7 +++++++
 reference/filesystem/functions/filemtime.xml     | 7 +++++++
 reference/filesystem/functions/fileowner.xml     | 7 +++++++
 reference/filesystem/functions/fileperms.xml     | 7 +++++++
 reference/filesystem/functions/filesize.xml      | 7 +++++++
 reference/filesystem/functions/filetype.xml      | 7 +++++++
 reference/filesystem/functions/is-dir.xml        | 7 +++++++
 reference/filesystem/functions/is-executable.xml | 7 +++++++
 reference/filesystem/functions/is-file.xml       | 7 +++++++
 reference/filesystem/functions/is-link.xml       | 7 +++++++
 reference/filesystem/functions/is-readable.xml   | 7 +++++++
 reference/filesystem/functions/is-writable.xml   | 7 +++++++
 reference/filesystem/functions/lstat.xml         | 7 +++++++
 16 files changed, 112 insertions(+)

diff --git a/reference/filesystem/functions/file-exists.xml b/reference/filesystem/functions/file-exists.xml
index de69471e60..5a91903838 100644
--- a/reference/filesystem/functions/file-exists.xml
+++ b/reference/filesystem/functions/file-exists.xml
@@ -88,6 +88,13 @@ if (file_exists($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/fileatime.xml b/reference/filesystem/functions/fileatime.xml
index 65e03d786d..723b52616d 100644
--- a/reference/filesystem/functions/fileatime.xml
+++ b/reference/filesystem/functions/fileatime.xml
@@ -64,6 +64,13 @@ if (file_exists($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
diff --git a/reference/filesystem/functions/filectime.xml b/reference/filesystem/functions/filectime.xml
index 40104da624..ecb5118eb2 100644
--- a/reference/filesystem/functions/filectime.xml
+++ b/reference/filesystem/functions/filectime.xml
@@ -64,6 +64,13 @@ if (file_exists($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
diff --git a/reference/filesystem/functions/fileinode.xml b/reference/filesystem/functions/fileinode.xml
index 70c0b90168..e32286326d 100644
--- a/reference/filesystem/functions/fileinode.xml
+++ b/reference/filesystem/functions/fileinode.xml
@@ -59,6 +59,13 @@ if (getmyinode() == fileinode($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/filemtime.xml b/reference/filesystem/functions/filemtime.xml
index 23a26a25f2..716336a3b4 100644
--- a/reference/filesystem/functions/filemtime.xml
+++ b/reference/filesystem/functions/filemtime.xml
@@ -64,6 +64,13 @@ if (file_exists($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.filesystem-time-res;
diff --git a/reference/filesystem/functions/fileowner.xml b/reference/filesystem/functions/fileowner.xml
index f4b604d76c..3ddffd504c 100644
--- a/reference/filesystem/functions/fileowner.xml
+++ b/reference/filesystem/functions/fileowner.xml
@@ -59,6 +59,13 @@ print_r(posix_getpwuid(fileowner($filename)));
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/fileperms.xml b/reference/filesystem/functions/fileperms.xml
index 9200ab795e..f721ad4561 100644
--- a/reference/filesystem/functions/fileperms.xml
+++ b/reference/filesystem/functions/fileperms.xml
@@ -129,6 +129,13 @@ echo $info;
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/filesize.xml b/reference/filesystem/functions/filesize.xml
index a6749255c2..da98d30c00 100644
--- a/reference/filesystem/functions/filesize.xml
+++ b/reference/filesystem/functions/filesize.xml
@@ -70,6 +70,13 @@ echo $filename . ': ' . filesize($filename) . ' bytes';
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/filetype.xml b/reference/filesystem/functions/filetype.xml
index 7a76f6fcd6..57db0630b8 100644
--- a/reference/filesystem/functions/filetype.xml
+++ b/reference/filesystem/functions/filetype.xml
@@ -65,6 +65,13 @@ echo filetype('/etc/');        // dir
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/is-dir.xml b/reference/filesystem/functions/is-dir.xml
index 6805f7e657..ed8a890d06 100644
--- a/reference/filesystem/functions/is-dir.xml
+++ b/reference/filesystem/functions/is-dir.xml
@@ -73,6 +73,13 @@ bool(true)
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/is-executable.xml b/reference/filesystem/functions/is-executable.xml
index b8f2f9a2a5..5208109db6 100644
--- a/reference/filesystem/functions/is-executable.xml
+++ b/reference/filesystem/functions/is-executable.xml
@@ -90,6 +90,13 @@ if (is_executable($file)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/is-file.xml b/reference/filesystem/functions/is-file.xml
index ab034f03f1..e395eb95f0 100644
--- a/reference/filesystem/functions/is-file.xml
+++ b/reference/filesystem/functions/is-file.xml
@@ -65,6 +65,13 @@ bool(false)
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/is-link.xml b/reference/filesystem/functions/is-link.xml
index e57a2e6c17..d5a8e55fd8 100644
--- a/reference/filesystem/functions/is-link.xml
+++ b/reference/filesystem/functions/is-link.xml
@@ -63,6 +63,13 @@ if (is_link($link)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;
diff --git a/reference/filesystem/functions/is-readable.xml b/reference/filesystem/functions/is-readable.xml
index 821d6e7213..9ceb0f8ff3 100644
--- a/reference/filesystem/functions/is-readable.xml
+++ b/reference/filesystem/functions/is-readable.xml
@@ -62,6 +62,13 @@ if (is_readable($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <para>
diff --git a/reference/filesystem/functions/is-writable.xml b/reference/filesystem/functions/is-writable.xml
index b692dba899..2d86944cdb 100644
--- a/reference/filesystem/functions/is-writable.xml
+++ b/reference/filesystem/functions/is-writable.xml
@@ -69,6 +69,13 @@ if (is_writable($filename)) {
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   
diff --git a/reference/filesystem/functions/lstat.xml b/reference/filesystem/functions/lstat.xml
index b363565e8d..da88484c36 100644
--- a/reference/filesystem/functions/lstat.xml
+++ b/reference/filesystem/functions/lstat.xml
@@ -83,6 +83,13 @@ Array
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Upon failure, an <constant>E_WARNING</constant> is emitted.
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   &note.clearstatcache;