<?xml version="1.0" encoding="UTF-8"?>

<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>streamWrapper クラス</title>

<titleabbrev>streamWrapper</titleabbrev>

<partintro>

<section xml:id="streamwrapper.intro">

&reftitle.intro;

<para>

独自のプロトコルハンドラやストリームを実装し、

(<function>fopen</function> や <function>fread</function> などの)

他のファイルシステム関数で使用できるようにします。

</para>

<note>

<para>

これは、実際のクラスでは<emphasis>ありません</emphasis>。

クラスがどのようにプロトコルを定義すべきかを示す、単なるプロトタイプです。

</para>

</note>

<note>

<para>

ここに示す方法以外でメソッドを実装した場合の挙動は未定義となります。

</para>

</note>

<para>

このクラスのインスタンスは、

関連付けられているプロトコルへのストリーム関数からのアクセスがあった時点で初期化されます。

</para>

</section>

<section xml:id="streamwrapper.synopsis">

&reftitle.classsynopsis;

<classsynopsis>

<ooclass><classname>streamWrapper</classname></ooclass>

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

<section xml:id="streamwrapper.props">

&reftitle.properties;

<variablelist>

<varlistentry xml:id="streamwrapper.props.context">

<term>resource <varname>context</varname></term>

<listitem>

<para>

現在の<link linkend="context">コンテキスト</link>、

あるいは呼び出し元からコンテキストが渡されていない場合は &null;。

</para>

<para>

<function>stream_context_get_options</function>

を用いてコンテキストをパースします。

</para>

<note>

<para>

このプロパティは<emphasis>必ず</emphasis> public とし、

PHP が実際のコンテキストリソースを設定できるようにしなければなりません。

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