Document userspance/url_stat method

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@145400 c90b9560-bf6c-de11-be94-00142212c4b1

reference/stream/functions/stream-wrapper-register.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
   <refentry id="function.stream-wrapper-register">
    <refnamediv>
     <refname>stream_wrapper_register</refname>
@@ -224,13 +224,10 @@
      </simpara>
     </note>
 
-<!--
-    Note: url_stat() is not yet implemented.  
-          ext/standard/filestat.c needs to route through wrappers first.
-
     <methodsynopsis>
      <type>array</type><methodname>url_stat</methodname>
      <methodparam><type>string</type><parameter>path</parameter></methodparam>
+     <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
     <para>
      This method is called in response to <function>stat</function>
@@ -239,7 +236,6 @@
      possible.  Unknown or unavailable values should be set to a
      rational value (usually <constant>0</constant>).
     </para>
--->
 
     <methodsynopsis>
      <type>bool</type><methodname>dir_opendir</methodname>
@@ -254,6 +250,43 @@
      expected to explore.  You can use <function>parse_url</function>
      to break it apart.
     </para>
+    <para>
+     <parameter>flags</parameter> holds additional flags set
+     by the streams API. It can hold one or more of the following
+     values OR'd together.
+     <informaltable>
+      <tgroup cols="2">
+       <thead>
+        <row>
+         <entry>Flag</entry>
+         <entry>Description</entry>
+        </row>
+       </thead>
+       <tbody>
+        <row>
+         <entry>STREAM_URL_STAT_LINK</entry>
+         <entry>
+          For resources with the ability to link to other resource
+          (such as an HTTP Location: forward, or a filesystem
+          symlink).  This flag specified that only information
+          about the link itself should be returned.  Not the
+          resource pointed to by the link.  This flag is set in
+          response to calls to <function>lstat</function>,
+          <function>is_link</function>, or <function>filetype</function>.
+         </entry>
+        </row>
+        <row>
+         <entry>STREAM_URL_STAT_QUIET</entry>
+         <entry>If this flag is set, your wrapper should not raise any
+          errors.  If this flag is not set, you are responsible for
+          reporting errors using the <function>trigger_error</function> 
+          function during stating of the path.  
+         </entry>
+        </row>
+       </tbody>
+      </tgroup>
+     </informaltable>
+    </para>
 
     <methodsynopsis>
      <type>string</type><methodname>dir_readdir</methodname>