php-doc-ru/reference/zlib/functions/deflate_init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 02ba67b51f2bde571b6ce07026e935f4e81019af Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>Инициализировать контекст инкрементального сжатия</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>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Инициализирует контекст инкрементального сжатия с использованием указанной кодировки
   <parameter>encoding</parameter>.
  </para>
  <para>
   Обратите внимание, что опция <literal>window</literal> задаёт только
   размер окна алгоритма, в отличие от фильтров zlib, где одноимённая
   опция также используется для установки используемой кодировки; кодировка
   должна быть установлена с помощью параметра <parameter>encoding</parameter>.
  </para>
  <para>
   Ограничения: в текущий момент невозможно установить информацию заголовка для сжатого
   потока GZIP, которая устанавливается следующим образом: подпись GZIP (<literal>\x1f\x8B</literal>);
   метод сжатия (<literal>\x08</literal> == DEFLATE); 6 нулевых байтов;
   текущая операционная система (<literal>\x00</literal> = Windows,
   <literal>\x03</literal> = Unix и т.д.)
  </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>
          Размер окна zlib (логарифмический) в диапазоне <literal>8</literal>..<literal>15</literal>;
          по умолчанию <literal>15</literal>.
          zlib изменяет размер окна с <literal>8</literal> на <literal>9</literal>,
          а с zlib 1.2.8 будет выдавать предупреждение, если запрашивается
          размер окна равный <literal>8</literal> для
          <constant>ZLIB_ENCODING_RAW</constant> или <constant>ZLIB_ENCODING_GZIP</constant>.
         </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>
          Строка или массив строк текущего словаря (по умолчанию предустановленного словаря нет).
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Возвращает ресурс контекста сжатия (<literal>zlib.deflate</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>DeflateContext</classname>;
       раньше, возвращался ресурс (<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
-->