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

<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 class="union"><type>array</type><type>object</type></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_<replaceable>*</replaceable></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>

Размер окна zlib (логарифмический) в диапазоне 8..15; по умолчанию 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>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>