deflate_init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: Fan2Shrek 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>Initialise un contexte de compressage incrémentiel</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>
   Initialise un contexte de compressage incrémentiel en utilisant le
   <parameter>encoding</parameter> spécifié.
  </para>
  <para>
   Il est à noter que l'option <literal>window</literal> ne définit ici que la taille de la fenêtre
   de l'algorithme, différemment des filtres zlib où le même paramètre définit également
   l'encodage à utiliser ; l'encodage doit être défini avec le paramètre
   <parameter>encoding</parameter>.
  </para>
  <para>
   Limitation : il n'y a actuellement aucun moyen de définir les informations d'en-tête sur un flux compressé GZIP,
   qui sont définies comme suit : signature GZIP
   (<literal>\x1f\x8B</literal>) ; méthode de compression (<literal>\x08</literal>
   == DEFLATE) ; 6 octets nuls ; le système d'exploitation défini sur le système actuel
   (<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>
      Une des constantes <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Un tableau associatif qui peut contenir les éléments suivants :
      <variablelist>
       <varlistentry>
        <term><varname>level</varname></term>
        <listitem>
         <para>
          Le niveau de compression dans la plage -1..9 ; par défaut -1.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>memory</varname></term>
        <listitem>
         <para>
          Le niveau de mémoire de compression dans la plage 1..9 ; par défaut 8.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>window</varname></term>
        <listitem>
         <para>
          La taille de la fenêtre zlib (logarithmique) dans la plage <literal>8</literal>..<literal>15</literal>;
          par défaut <literal>15</literal>.
          zlib change une taille de fenêtre de <literal>8</literal> à <literal>9</literal>,
          et à partir de zlib 1.2.8 échoue avec un avertissement, si une taille de fenêtre de <literal>8</literal>
          est demandée pour <constant>ZLIB_ENCODING_RAW</constant> ou <constant>ZLIB_ENCODING_GZIP</constant>.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>strategy</varname></term>
        <listitem>
         <para>
          Une des <constant>ZLIB_FILTERED</constant>,
          <constant>ZLIB_HUFFMAN_ONLY</constant>, <constant>ZLIB_RLE</constant>,
          <constant>ZLIB_FIXED</constant> ou
          <constant>ZLIB_DEFAULT_STRATEGY</constant> (par défaut).
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><varname>dictionary</varname></term>
        <listitem>
         <para>
          Un <type>string</type> ou un <type>array</type> de <type>strings</type>
          du dictionnaire prédéfini (par défaut : aucun dictionnaire prédéfini).
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Renvoie un contexte de compressage (<literal>zlib.deflate</literal>) sur
   succès, &return.falseforfailure;.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   Si une option invalide est passée à <parameter>options</parameter> ou que le
   contexte n'a pas pu être créé, une erreur de niveau <constant>E_WARNING</constant>
   est générée.
  </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 cas de succès, cette fonction renvoie désormais une instance de <classname>DeflateContext</classname> ;
       précédemment, une <type>resource</type> était renvoyée.
      </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
-->