Document the flags parameter

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@277779 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2009-03-25 18:54:33 +00:00
parent cae20c68e5
commit 9709670c63

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
<!-- $Revision: 1.22 $ -->
<refentry xml:id="function.stream-wrapper-register" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_wrapper_register</refname>
@ -11,6 +11,7 @@
<type>bool</type><methodname>stream_wrapper_register</methodname>
<methodparam><type>string</type><parameter>protocol</parameter></methodparam>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter> <initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Allows you to implement your own protocol handlers and streams for use
@ -39,6 +40,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Should be set to <constant>STREAM_IS_URL</constant> if
<parameter>protocol</parameter> is a URL protocol. Default is 0, local
stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -54,6 +65,31 @@
</para>
</refsect1>
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.2.4</entry>
<entry>
Added the <parameter>flags</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1><!-- }}} -->
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>