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

<!-- EN-Revision: aa120f36c5762e99f9ee121d8caf910e0a67121e Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.deflate-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>deflate_init</refname>

<refpurpose>Inicializa un contexto de compresión incremental</refpurpose>

</refnamediv>

<refsect1 role="description"><!-- {{{ -->

&reftitle.description;

<methodsynopsis>

<type class="union"><type>DeflateContext</type><type>false</type></type><methodname>deflate_init</methodname>

<methodparam><type>int</type><parameter>encoding</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>options</parameter><initializer>[]</initializer></methodparam>

</methodsynopsis>

<para>

Inicializa un contexto de compresión incremental utilizando el

<parameter>encoding</parameter> especificado.

</para>

<para>

Es importante señalar que la opción <literal>window</literal> aquí solo define el tamaño de la ventana

del algoritmo, diferente de los filtros zlib donde el mismo parámetro también define

la codificación a utilizar; la codificación debe ser definida con el parámetro

<parameter>encoding</parameter>.

</para>

<para>

Limitación: actualmente no hay manera de establecer la información del encabezado en un flujo comprimido GZIP,

que se define como sigue: firma GZIP

(<literal>\x1f\x8B</literal>); método de compresión (<literal>\x08</literal>

== DEFLATE); 6 bytes nulos; el sistema operativo establecido en el sistema actual

(<literal>\x00</literal> = Windows, <literal>\x03</literal> = Unix, etc.).

</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 zlib (logarítmico) en el rango <literal>8</literal>..<literal>15</literal>;

por defecto <literal>15</literal>.

zlib cambia un tamaño de ventana de <literal>8</literal> a <literal>9</literal>,

y a partir de zlib 1.2.8 falla con una advertencia, si se solicita un tamaño de ventana de <literal>8</literal>

para <constant>ZLIB_ENCODING_RAW</constant> o <constant>ZLIB_ENCODING_GZIP</constant>.

</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 compresión (<literal>zlib.deflate</literal>) en caso de

éxito, &return.falseforfailure;.

</para>

</refsect1><!-- }}} -->

<refsect1 role="errors"><!-- {{{ -->

&reftitle.errors;

<para>

Si se pasa 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>DeflateContext</classname>;

anteriormente, se devolvía un <type>resource</type>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso"><!-- {{{ -->

&reftitle.seealso;

<simplelist>

<member><function>deflate_add</function></member>

<member><function>inflate_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

-->