inflate_init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<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>Inicializa un contexto de descompresión incremental</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>
    Inicializa un contexto de descompresión incremental con el <parameter>encoding</parameter>
    especificado.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      Una de las constantes <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Un array asociativo que puede contener los siguientes elementos:
      <variablelist>
       <varlistentry>
        <term><varname>level</varname></term>
        <listitem>
         <para>
          El nivel de compresión en el rango -1..9; por defecto -1.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>memory</varname></term>
        <listitem>
         <para>
          El nivel de memoria de compresión en el rango 1..9; por defecto 8.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>window</varname></term>
        <listitem>
         <para>
          El tamaño de la ventana de compresión (logarítmica) en el rango 8..15; por defecto 15.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>strategy</varname></term>
        <listitem>
         <para>
          Una de las <constant>ZLIB_FILTERED</constant>,
          <constant>ZLIB_HUFFMAN_ONLY</constant>, <constant>ZLIB_RLE</constant>,
          <constant>ZLIB_FIXED</constant> o
          <constant>ZLIB_DEFAULT_STRATEGY</constant> (por defecto).
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>dictionary</varname></term>
        <listitem>
         <para>
          Un <type>string</type> o un <type>array</type> de <type>strings</type>
          del diccionario predefinido (por defecto: ningún diccionario predefinido).
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Devuelve un contexto de descompresión (<literal>zlib.inflate</literal>) en caso de
   éxito, &return.falseforfailure;.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   Si se pasa un codificación o una opción inválida a <parameter>options</parameter>,
   o si el contexto no pudo ser creado, se genera un error de nivel
   <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>
       En caso de éxito, esta función ahora devuelve una instancia de <classname>InflateContext</classname>;
       anteriormente, se devolvía un <type>resource</type>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <simpara>
    A diferencia de <function>gzinflate</function>, los contextos de inflado incremental no
    limitan la longitud de los datos decodificados, por lo que no proporcionan ninguna protección
    automática contra las bombas 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
-->