streamwrapper.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.streamwrapper" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The streamWrapper class</title>
 <titleabbrev>streamWrapper</titleabbrev>

 <partintro>

<!-- {{{ streamWrapper intro -->
  <section xml:id="streamwrapper.intro">
   &reftitle.intro;
   <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>
   <note>
    <para>
     This is <emphasis>NOT</emphasis> a real class, only a prototype of how
     a class defining its own protocol should be. 
    </para>
   </note>
   <note>
    <para>
     Implementing the methods in other ways than described here can lead to
     undefined behaviour.
    </para>
   </note>
   <para>
    An instance of this class is initialized as soon as a stream function
    tries to access the protocol it is associated with.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="streamwrapper.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>streamWrapper</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname><replaceable>streamWrapper</replaceable></classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>resource</type>
     <varname linkend="streamwrapper.props.context">context</varname>
    </fieldsynopsis>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ streamWrapper properties -->
  <section xml:id="streamwrapper.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="streamwrapper.props.context">
     <term>resource <varname>context</varname></term>
     <listitem>
      <para>
       The current <link linkend="context">context</link>, or &null; if no
       context was passed to the caller function.
      </para>
      <para>
       Use the <function>stream_context_get_options</function> to parse the
       context.
      </para>
      <note>
       <para>
        This property <emphasis>must</emphasis> be public so PHP can populate
        it with the actual context resource.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

 <section role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="stream.streamwrapper.example-1" /></member>
    <member><function>stream_wrapper_register</function></member>
    <member><function>stream_wrapper_unregister</function></member>
    <member><function>stream_wrapper_restore</function></member>
   </simplelist>
  </para>
 </section><!-- }}} -->

 </partintro>

 &reference.stream.entities.streamwrapper;

</reference>

<!-- 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
-->