php-doc-en/reference/zlib/ini.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<section id="zlib.configuration">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  The zlib extension offers the option to transparently compress
  your pages on-the-fly, if the requesting browser supports
  this. Therefore there are three options in the <link
  linkend="configuration.file">configuration file</link> &php.ini;.
   <table>
   <title>Zlib Configuration Options</title>
   <tgroup cols="3">
    <thead>
     <row>
      <entry>Name</entry>
      <entry>Default</entry>
      <entry>Changeable</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>zlib.output_compression</entry>
      <entry>"Off"</entry>
      <entry>PHP_INI_ALL</entry>
     </row>
     <row>
      <entry>zlib.output_compression_level</entry>
      <entry>"-1"</entry>
      <entry>PHP_INI_ALL</entry>
     </row>
     <row>
      <entry>zlib.output_handler</entry>
      <entry>""</entry>
      <entry>PHP_INI_ALL</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
   For further details and definition of the PHP_INI_* constants see
  <function>ini_set</function>.
</para>
 
 &ini.descriptions.title;
 
 <para>
 <variablelist>
  <varlistentry id="ini.zlib.output-compression">
   <term>
    <parameter>zlib.output_compression</parameter>
    <type>boolean</type>/<type>integer</type>
   </term>
   <listitem>
    <para>
     Whether to transparently compress pages. If this option is set
     to "On" in &php.ini; or the Apache configuration, pages are
     compressed if the browser sends an "Accept-Encoding: gzip" or
     "deflate" header. "Content-Encoding: gzip" (respectively
     "deflate") and "Vary: Accept-Encoding" headers are added to
     the output.
    </para>
    <para>
     You can use <function>ini_set</function> to disable this in
     your script if the headers aren't already sent. If you output
     a "Content-Type: image/" header the compression is disabled,
     too (in order to circumvent a Netscape bug). You can reenable
     it, if you add "ini_set('zlib.output_compression', 'On')"
     after the header call which added the image content-type.
    </para>
    <para>
     This option also accepts integer values instead of boolean
     "On"/"Off", using this you can set the output buffer size
     (default is 4KB).
    </para>
    <note>
     <para>
      <link linkend="ini.output-handler">output_handler</link> must be 
      empty if this is set 'On' ! Instead you must use zlib.output_handler.
     </para>
    </note>
   </listitem>
  </varlistentry>

  <varlistentry id="ini.zlib.output-compression-level">
   <term>
    <parameter>zlib.output_compression_level</parameter>
    <type>integer</type>
   </term>
   <listitem>
    <para>
     Compression level used for transparent output compression.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry id="ini.zlib.output-handler">
   <term>
    <parameter>zlib.output_handler</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     You cannot specify additional output handlers if zlib.output_compression
     is activated here. This setting does the same as <link linkend="ini.output-handler">
     output_handler</link> but in a different order.
    </para>
   </listitem>
  </varlistentry>

 </variablelist>
 </para>
</section>

<!-- 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:"../../../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
-->