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

@@ -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;

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>

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>

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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>

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;
   

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;