stream-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a6afc9550480ad7aba8ab72d0286bd1b9ff41b04 Maintainer: takagi Status: ready -->

<refentry xml:id="streamwrapper.stream-open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_open</refname>
  <refpurpose>ファイルあるいは URL をオープンする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_open</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   <methodparam><type>int</type><parameter>options</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter role="reference">opened_path</parameter></methodparam>
  </methodsynopsis>
  <para>
   このメソッドは、ラッパーが初期化された
   (たとえば <function>fopen</function> や <function>file_get_contents</function>)
   直後にコールされます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       元の関数に渡す URL を指定します。
      </para>
      <note>
       <para>
        <function>parse_url</function> でこの URL が壊れることがあります。
        :// で区切った URL のみをサポートしていることに注意しましょう。
        : や :/ も技術的な面では妥当な URL ですが、サポートしていません。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       ファイルをオープンする際のモード。詳細は <function>fopen</function> を参照ください。
      </para>
      <note>
       <para>
        指定した <parameter>path</parameter> に対して
        <parameter>mode</parameter> が有効かどうかの確認を忘れないようにしましょう。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       ストリーム API が設定する追加のフラグ。次の値を OR で連結して指定します。
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>フラグ</entry>
           <entry>説明</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>STREAM_USE_PATH</constant></entry>
           <entry><parameter>path</parameter> が相対パスの場合は、
            include_path を用いてリソースを探します。
           </entry>
          </row>
          <row>
           <entry><constant>STREAM_REPORT_ERRORS</constant></entry>
           <entry>このフラグが設定されている場合、
            ストリームのオープン時のエラーを <function>trigger_error</function>
            で報告しなければなりません。フラグが設定されていない場合は、
            エラーを一切報告してはいけません。
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>opened_path</parameter></term>
     <listitem>
      <para>
       <parameter>path</parameter> のオープンに成功し、
       <constant>STREAM_USE_PATH</constant> が <parameter>options</parameter>
       に設定されていた場合、
       <parameter>opened_path</parameter> には実際にオープンしたファイル/リソース
       のフルパスを設定しなければなりません。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  &userstream.not.implemented.warning;
 </refsect1><!-- }}} -->
 

<!-- {{{
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::stream_open</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
}}}-->

 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  &userstream.updates.context;
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fopen</function></member>
    <member><function>parse_url</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
-->