<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-wrapper-register" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_wrapper_register</refname>
  <refpurpose>Register a URL wrapper implemented as a PHP class</refpurpose>
 </refnamediv>
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>stream_wrapper_register</methodname>
   <methodparam><type>string</type><parameter>protocol</parameter></methodparam>
   <methodparam><type>string</type><parameter>class</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
   with all the other filesystem functions (such as <function>fopen</function>,
   <function>fread</function> etc.).
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>protocol</parameter></term>
     <listitem>
      <para>
       The wrapper name to be registered.
       Valid protocol names must contain alphanumerics, dots (.), plusses (+), or hyphens (-) only.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>class</parameter></term>
     <listitem>
      <para>
       The classname which implements the <parameter>protocol</parameter>.
      </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>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   <function>stream_wrapper_register</function> will return &false; if the
   <parameter>protocol</parameter> already has a handler.
  </para>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example>
    <title>How to register a stream wrapper</title>
    <programlisting role="php">
<![CDATA[
<?php
$existed = in_array("var", stream_get_wrappers());
if ($existed) {
    stream_wrapper_unregister("var");
}
stream_wrapper_register("var", "VariableStream");
$myvar = "";

$fp = fopen("var://myvar", "r+");

fwrite($fp, "line1\n");
fwrite($fp, "line2\n");
fwrite($fp, "line3\n");

rewind($fp);
while (!feof($fp)) {
    echo fgets($fp);
}
fclose($fp);
var_dump($myvar);

if ($existed) {
    stream_wrapper_restore("var");
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
line1
line2
line3
string(18) "line1
line2
line3
"
]]>
    </screen>
   </example>
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>The <xref linkend="class.streamwrapper"/> prototype class</member>
    <member><xref linkend="stream.streamwrapper.example-1"/></member>
    <member><function>stream_wrapper_unregister</function></member>
    <member><function>stream_wrapper_restore</function></member>
    <member><function>stream_get_wrappers</function></member>
   </simplelist>
  </para>
 </refsect1><!-- }}} -->


</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
