cvs: phpdoc /en/appendices wrappers.xml /en/chapters streams.structs.xml /en/reference/filesystem/functions unlink.xml

pollita Wed May 14 18:04:51 2003 EDT Modified files: /phpdoc/en/appendices wrappers.xml /phpdoc/en/chapters streams.structs.xml /phpdoc/en/reference/filesystem/functions unlink.xml Log: Update documentation per addition of unlink method in wrappers operations. Create standardized table for listing wrapper attributes in appendices/wrappers.xml, this will ease lookup of common information by reducing what must be read through.

Index: phpdoc/en/appendices/wrappers.xml diff -u phpdoc/en/appendices/wrappers.xml:1.16 phpdoc/en/appendices/wrappers.xml:1.17 --- phpdoc/en/appendices/wrappers.xml:1.16 Sat Apr 26 23:46:16 2003 +++ phpdoc/en/appendices/wrappers.xml Wed May 14 18:04:50 2003 @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <appendix id="wrappers"> <title>List of Supported Protocols/Wrappers</title> <para> The following is a list of the various URL style protocols that PHP has built-in for use with the filesystem functions such as <function>fopen</function> and <function>copy</function>. - In addition to these wrappers, as of PHP 4.3, you can write + In addition to these wrappers, as of <literal>PHP 4.3.0</literal>, you can write your own wrappers using PHP script and <function>stream_register_wrapper</function>. </para> <section id="wrappers.http"> <title>HTTP and HTTPS</title> - <simpara>PHP 3, PHP 4. <filename>https://</filename> since PHP 4.3</simpara> + <simpara>PHP 3, PHP 4. <filename>https://</filename> since <literal>PHP 4.3.0</literal></simpara> <itemizedlist> <listitem><simpara><filename>http://example.com</filename></simpara></listitem> @@ -38,7 +38,7 @@ The stream allows access to the <emphasis>body</emphasis> of the resource; the headers are stored in the <varname>$http_response_header</varname> variable. - Since PHP 4.3, the headers are available using + Since <literal>PHP 4.3.0</literal>, the headers are available using <function>stream_get_meta_data</function>. </simpara> <simpara> @@ -46,12 +46,54 @@ files to an HTTP resource. </simpara> <note> - <simpara>HTTPS is supported starting from PHP 4.3, if you + <simpara>HTTPS is supported starting from <literal>PHP 4.3.0</literal>, if you have compiled in support for OpenSSL. </simpara> </note> <para> <table> + <title>Wrapper Summary</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Attribute</entry> + </row> + </thead> + <tbody> + <row> + <entry>Restricted by <literal>allow_url_fopen</literal>.</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Reading</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Writing</entry> + <entry>No</entry> + </row> + <row> + <entry>Allows Appending</entry> + <entry>No</entry> + </row> + <row> + <entry>Allows Simultaneous Reading and Writing</entry> + <entry>N/A</entry> + </row> + <row> + <entry>Supports <function>stat</function></entry> + <entry>No</entry> + </row> + <row> + <entry>Supports <function>unlink</function></entry> + <entry>No</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + <table> <title>Context options (as of <literal>PHP 5.0</literal>)</title> <tgroup cols="3"> <thead> @@ -115,7 +157,7 @@ <section id="wrappers.ftp"> <title>FTP and FTPS</title> - <simpara>PHP 3, PHP 4. <filename>ftps://</filename> since PHP 4.3</simpara> + <simpara>PHP 3, PHP 4. <filename>ftps://</filename> since <literal>PHP 4.3.0</literal></simpara> <itemizedlist> <listitem><simpara><filename>ftp://example.com/pub/file.txt</filename></simpara></listitem> @@ -136,7 +178,7 @@ the context option <literal>overwrite</literal>, the connection will fail. If you need to overwrite existing files over ftp, specify the <literal>overwrite</literal> option in the context - and open the file for writting. Alternatively, you can + and open the file for writing. Alternatively, you can use the <link linkend="ref.ftp">FTP extension</link>. </simpara> <note> @@ -148,19 +190,65 @@ </simpara> </note> <simpara> - <filename>ftps://</filename> was introduced in PHP 4.3. + <filename>ftps://</filename> was introduced in <literal>PHP 4.3.0</literal>. It is the same as <filename>ftp://</filename>, but attempts to negotiate a secure connection with the ftp server. If the server does not support SSL, then the connection falls back to regular unencrypted ftp. </simpara> <note> - <simpara>FTPS is supported starting from PHP 4.3, if you + <simpara>FTPS is supported starting from <literal>PHP 4.3.0</literal>, if you have compiled in support for OpenSSL. </simpara> </note> <para> <table> + <title>Wrapper Summary</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Attribute</entry> + </row> + </thead> + <tbody> + <row> + <entry>Restricted by <literal>allow_url_fopen</literal>.</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Reading</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Writing</entry> + <entry> + Yes (Prior to <literal>PHP 5.0.0</literal>: new files only. + <literal>PHP 5.0.0</literal> and later: overwrite allowed + with context option) + </entry> + </row> + <row> + <entry>Allows Appending</entry> + <entry>Yes (<literal>PHP 5.0.0</literal> or later)</entry> + </row> + <row> + <entry>Allows Simultaneous Reading and Writing</entry> + <entry>No</entry> + </row> + <row> + <entry>Supports <function>stat</function></entry> + <entry>No</entry> + </row> + <row> + <entry>Supports <function>unlink</function></entry> + <entry>Yes (<literal>PHP 5.0.0</literal> or later)</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + <table> <title>Context options (as of <literal>PHP 5.0</literal>)</title> <tgroup cols="3"> <thead> @@ -174,7 +262,7 @@ <row> <entry><literal>overwrite</literal></entry> <entry> - Allow overwritting of already existing files on remote server. + Allow overwriting of already existing files on remote server. </entry> <entry>&false; (Disabled)</entry> </row> @@ -199,8 +287,8 @@ <title>PHP input/output streams</title> <simpara> <literal>PHP 3.0.13</literal> and up, <filename>php://output</filename> - and <filename>php://input</filename> since <literal>PHP 4.3</literal>, - <filename>php://filter</filename> since <literal>PHP 5.0</literal> + and <filename>php://input</filename> since <literal>PHP 4.3.0</literal>, + <filename>php://filter</filename> since <literal>PHP 5.0.0</literal> </simpara> <itemizedlist> @@ -322,12 +410,68 @@ </simpara> </listitem> </itemizedlist> + <para> + <table> + <title> + Wrapper Summary (For <literal>php://filter</literal>, + refer to summary of wrapper being filtered.) + </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Attribute</entry> + </row> + </thead> + <tbody> + <row> + <entry>Restricted by <literal>allow_url_fopen</literal>.</entry> + <entry>No</entry> + </row> + <row> + <entry>Allows Reading</entry> + <entry> + <literal>php://stdin</literal> and + <literal>php://input</literal> only. + </entry> + </row> + <row> + <entry>Allows Writing</entry> + <entry> + <literal>php://stdout</literal>, + <literal>php://stderr</literal>, and + <literal>php://output</literal> only. + </entry> + </row> + <row> + <entry>Allows Appending</entry> + <entry> + <literal>php://stdout</literal>, + <literal>php://stderr</literal>, and + <literal>php://output</literal> only. (Equivalent to writing) + </entry> + </row> + <row> + <entry>Allows Simultaneous Reading and Writing</entry> + <entry>No. These wrappers are unidirectional.</entry> + </row> + <row> + <entry>Supports <function>stat</function></entry> + <entry>No</entry> + </row> + <row> + <entry>Supports <function>unlink</function></entry> + <entry>No</entry> + </row> + </tbody> + </tgroup> + </table> + </para> </section> <section id="wrappers.compression"> <title>Compression Streams</title> <simpara><filename>zlib:</filename> PHP 4.0.4 - PHP 4.2.3 (systems with fopencookie only)</simpara> - <simpara><filename>compress.zlib://</filename> and <filename>compress.bzip2://</filename> PHP 4.3 and up</simpara> + <simpara><filename>compress.zlib://</filename> and <filename>compress.bzip2://</filename> PHP 4.3.0 and up</simpara> <itemizedlist> <listitem><simpara><filename>zlib:</filename></simpara></listitem> @@ -338,7 +482,7 @@ <simpara> <filename>zlib:</filename> works like <function>gzopen</function>, except that the stream can be used with <function>fread</function> and the other - filesystem functions. This is deprecated as of PHP 4.3 due + filesystem functions. This is deprecated as of <literal>PHP 4.3.0</literal> due to ambiguities with filenames containing ':' characters; use <filename>compress.zlib://</filename> instead. </simpara> @@ -350,6 +494,54 @@ respectively, and operate even on systems that do not support fopencookie. </simpara> + <para> + <table> + <title>Wrapper Summary</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Attribute</entry> + </row> + </thead> + <tbody> + <row> + <entry>Restricted by <literal>allow_url_fopen</literal>.</entry> + <entry>No</entry> + </row> + <row> + <entry>Allows Reading</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Writing</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Appending</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Allows Simultaneous Reading and Writing</entry> + <entry>No</entry> + </row> + <row> + <entry>Supports <function>stat</function></entry> + <entry> + No, use the normal <literal>file://</literal> wrapper + to stat compressed files. + </entry> + </row> + <row> + <entry>Supports <function>unlink</function></entry> + <entry> + No, use the normal <literal>file://</literal> wrapper + to unlink compressed files. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> </section> </appendix> Index: phpdoc/en/chapters/streams.structs.xml diff -u phpdoc/en/chapters/streams.structs.xml:1.3 phpdoc/en/chapters/streams.structs.xml:1.4 --- phpdoc/en/chapters/streams.structs.xml:1.3 Thu May 8 17:04:24 2003 +++ phpdoc/en/chapters/streams.structs.xml Wed May 14 18:04:50 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Author: Wez Furlong <wez@thebrainroom.com> Please contact me before making any major amendments to the content of this section. Splitting/Merging are fine if they are @@ -115,6 +115,9 @@ int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC); const char *label; + + /* Delete/Unlink a file */ + int (*unlink)(php_stream_wrapper *wrapper, char *url, int options, php_stream_context *context TSRMLS_DC); } php_stream_wrapper_ops; </programlisting> </refsect1> Index: phpdoc/en/reference/filesystem/functions/unlink.xml diff -u phpdoc/en/reference/filesystem/functions/unlink.xml:1.2 phpdoc/en/reference/filesystem/functions/unlink.xml:1.3 --- phpdoc/en/reference/filesystem/functions/unlink.xml:1.2 Wed Apr 17 02:38:11 2002 +++ phpdoc/en/reference/filesystem/functions/unlink.xml Wed May 14 18:04:50 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.unlink"> <refnamediv> @@ -19,6 +19,13 @@ <para> &return.success; </para> + <note> + <simpara> + As of <literal>PHP 5.0.0</literal> <function>unlink</function> can also be + used with <emphasis>some</emphasis> url wrappers. Refer to <xref linkend="wrappers"/> + for a listing of which wrappers support <function>unlink</function>. + </simpara> + </note> <para> See also <function>rmdir</function> for removing directories. </para>