inflate_init.xml

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

<refentry xml:id="function.inflate-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>inflate_init</refname>
  <refpurpose>インクリメンタルな解凍コンテキストを初期化する</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>InflateContext</type><type>false</type></type><methodname>inflate_init</methodname>
   <methodparam><type>int</type><parameter>encoding</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
    指定された <parameter>encoding</parameter> でインクリメンタルな解凍コンテキストを初期化します
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      定数 <constant>ZLIB_ENCODING_*</constant> のうちのひとつ
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      次の要素を含む連想配列:
      <variablelist>
       <varlistentry>
        <term><varname>level</varname></term>
        <listitem>
         <para>
          -1 .. 9 までの圧縮レベル。デフォルトは -1 です。
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>memory</varname></term>
        <listitem>
         <para>
          1 .. 9 までの圧縮メモリレベル。デフォルトは8です。
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>window</varname></term>
        <listitem>
         <para>
          8 .. 15 までの zlib の window サイズ(対数)。
          デフォルトは 15 です。
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>strategy</varname></term>
        <listitem>
         <para>
          <constant>ZLIB_FILTERED</constant>,
          <constant>ZLIB_HUFFMAN_ONLY</constant>, <constant>ZLIB_RLE</constant>,
          <constant>ZLIB_FIXED</constant>,
          <constant>ZLIB_DEFAULT_STRATEGY</constant> (デフォルト) のうちのひとつです。
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>dictionary</varname></term>
        <listitem>
         <para>
          あらかじめ設定されたディクショナリの
          <type>string</type> または
          <type>strings</type> の <type>array</type>。
          (デフォルト: 辞書なし)
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   成功した場合、解凍コンテキストリソース(<literal>zlib.inflate</literal>) を返します。
   &return.falseforfailure;
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   不正なオプションが <parameter>options</parameter> に渡されたり、
   コンテキストが作れなかった場合には、 <constant>E_WARNING</constant> レベルのエラーが発生します。
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       成功時に、この関数は
       <classname>InflateContext</classname> 
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       <type>resource</type> を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <simpara>
    <function>gzinflate</function> と異なり、
    インクリメンタルな解凍コンテキストは、
    解凍済みデータの大きさを強制しません。
    よって、Zip爆弾を自動的に防御できません。
   </simpara>
  </caution>
 </refsect1>

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <simplelist>
   <member><function>inflate_add</function></member>
   <member><function>deflate_init</function></member>
  </simplelist>
 </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
-->