From 5b2760da9dca574a3440358890d0e09113b49a78 Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Sat, 13 Dec 2003 23:10:26 +0000
Subject: [PATCH] Document rename/mkdir/rmdir methods for userspace wrappers.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146390 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/stream-wrapper-register.xml     | 69 ++++++++++++++++++-
 1 file changed, 68 insertions(+), 1 deletion(-)

diff --git a/reference/stream/functions/stream-wrapper-register.xml b/reference/stream/functions/stream-wrapper-register.xml
index b0bc1d3ac8..c6938a7279 100644
--- a/reference/stream/functions/stream-wrapper-register.xml
+++ b/reference/stream/functions/stream-wrapper-register.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
   <refentry id="function.stream-wrapper-register">
    <refnamediv>
     <refname>stream_wrapper_register</refname>
@@ -224,6 +224,73 @@
      </simpara>
     </note>
 
+    <methodsynopsis>
+     <type>bool</type><methodname>rename</methodname>
+     <methodparam><type>string</type><parameter>path_from</parameter></methodparam>
+     <methodparam><type>string</type><parameter>path_to</parameter></methodparam>
+    </methodsynopsis>
+    <para>
+     This method is called in response to <function>rename</function>
+     calls on URL paths associated with the wrapper and should attempt
+     to rename the item specified by <parameter>path_from</parameter>
+     to the specification given by <parameter>path_to</parameter>.
+     It should return &true; on success or &false; on failure.
+     In order for the appropriate error message to be returned,
+     do not define this method if your wrapper does not support renaming.
+    </para>
+    <note>
+     <simpara>
+      Userspace wrapper rename method is not supported prior to 
+      <literal>PHP 5.0.0</literal>.
+     </simpara>
+    </note>
+
+    <methodsynopsis>
+     <type>bool</type><methodname>mkdir</methodname>
+     <methodparam><type>string</type><parameter>path</parameter></methodparam>
+     <methodparam><type>int</type><parameter>mode</parameter></methodparam>
+     <methodparam><type>int</type><parameter>options</parameter></methodparam>
+    </methodsynopsis>
+    <para>
+     This method is called in response to <function>mkdir</function>
+     calls on URL paths associated with the wrapper and should attempt
+     to create the directory specified by <parameter>path</parameter>.
+     It should return &true; on success or &false; on failure.
+     In order for the appropriate error message to be returned,
+     do not define this method if your wrapper does not support 
+     creating directories.  Posible values for <parameter>options</parameter>
+     include <constant>REPORT_ERRORS</constant> and 
+     <constant>STREAM_MKDIR_RECURSIVE</constant>.
+    </para>
+    <note>
+     <simpara>
+      Userspace wrapper mkdir method is not supported prior to 
+      <literal>PHP 5.0.0</literal>.
+     </simpara>
+    </note>
+
+    <methodsynopsis>
+     <type>bool</type><methodname>rmdir</methodname>
+     <methodparam><type>string</type><parameter>path</parameter></methodparam>
+     <methodparam><type>int</type><parameter>options</parameter></methodparam>
+    </methodsynopsis>
+    <para>
+     This method is called in response to <function>rmdir</function>
+     calls on URL paths associated with the wrapper and should attempt
+     to remove the directory specified by <parameter>path</parameter>.
+     It should return &true; on success or &false; on failure.
+     In order for the appropriate error message to be returned,
+     do not define this method if your wrapper does not support 
+     removing directories.  Possible values for <parameter>options</parameter>
+     include <constant>REPORT_ERRORS</constant>.
+    </para>
+    <note>
+     <simpara>
+      Userspace wrapper rmdir method is not supported prior to 
+      <literal>PHP 5.0.0</literal>.
+     </simpara>
+    </note>
+
     <methodsynopsis>
      <type>bool</type><methodname>dir_opendir</methodname>
      <methodparam><type>string</type><parameter>path</parameter></methodparam>