pollita Fri Jan 3 13:17:06 2003 EDT
Modified files:
/phpdoc/en/reference/stream reference.xml
Log:
Added brief description of user defined filters, fixed CDATA endtag.
Index: phpdoc/en/reference/stream/reference.xml
diff -u phpdoc/en/reference/stream/reference.xml:1.2
phpdoc/en/reference/stream/reference.xml:1.3
--- phpdoc/en/reference/stream/reference.xml:1.2 Thu Jan 2 21:54:21 2003
+++ phpdoc/en/reference/stream/reference.xml Fri Jan 3 13:17:05 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<reference id="ref.stream">
<title>Stream functions</title>
<titleabbrev>Streams</titleabbrev>
@@ -21,6 +21,12 @@
set limit on what can be done with them. See <xref linkend="wrappers"/>
for a listing of stream wrappers built into <literal>PHP</literal>.
</simpara>
+ <simpara>
+ In addition to streams, support for custom user filters is also available.
+ While a stream (such as 'http') is designed to communicate with an endpoint,
+ one or more filters can be placed between the stream and the application to
+ further process the data as it is read/written.
+ </simpara>
<para>
A stream is referenced as:
<parameter>scheme</parameter>://<parameter>target</parameter>
<itemizedlist>
@@ -43,11 +49,6 @@
</listitem>
</itemizedlist>
</para>
- <simpara>
- Filters may also be applied to streams to further process data on its
- way into or out of a stream related call. Documentation on this
- functionality is comming soon.
- </simpara>
</section>
<section id="stream.requirements">
@@ -69,8 +70,17 @@
</section>
<section id="stream.resources">
- &reftitle.resources;
- &no.resource;
+ <title>Stream Classes</title>
+ <simpara>
+ User designed wrappers can be registered via
+<function>stream_register_wrapper</function>,
+ using the class definition shown on that manual page.
+ </simpara>
+ <simpara>
+ <literal>class</literal> php_user_filter is predefined and is an abstract
+ baseclass for use with user defined filters. See the manual page for
+ <function>stream_register_filter</function> for details on implementing
+ user defined filters.
+ </simpara>
</section>
<section id="stream.constants">
@@ -107,7 +117,7 @@
$ftpfile = file_get_contents("ftp://user:[EMAIL PROTECTED]/foo.txt";); // Read
remote file from ftp.example.com using FTP
$ftpsfile = file_get_contents("ftps://user:[EMAIL PROTECTED]/foo.txt"); // Read
remote file from ftp.example.com using FTPS
?>
-]]?>
+]]>
</programlisting>
</example>
</para>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
