pollita Sat Dec 13 18:10:27 2003 EDT
Modified files:
/phpdoc/en/reference/stream/functions stream-wrapper-register.xml
Log:
Document rename/mkdir/rmdir methods for userspace wrappers.
Index: phpdoc/en/reference/stream/functions/stream-wrapper-register.xml
diff -u phpdoc/en/reference/stream/functions/stream-wrapper-register.xml:1.6
phpdoc/en/reference/stream/functions/stream-wrapper-register.xml:1.7
--- phpdoc/en/reference/stream/functions/stream-wrapper-register.xml:1.6 Tue
Dec 2 17:13:01 2003
+++ phpdoc/en/reference/stream/functions/stream-wrapper-register.xml Sat Dec 13
18:10:26 2003
@@ -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>
@@ -225,6 +225,73 @@
</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>
<methodparam><type>int</type><parameter>options</parameter></methodparam>
