Added brief description of user defined filters, fixed CDATA endtag.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@110216 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2003-01-03 18:17:05 +00:00
parent 14cf77e0fe
commit bb54371cbb

View file

@ -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 @@ $httpsfile = file_get_contents("https://www.example.com/foo.txt"); //
$ftpfile = file_get_contents("ftp://user:pass@ftp.example.com/foo.txt"); // Read remote file from ftp.example.com using FTP
$ftpsfile = file_get_contents("ftps://user:pass@ftp.example.com/foo.txt"); // Read remote file from ftp.example.com using FTPS
?>
]]?>
]]>
</programlisting>
</example>
</para>