<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ob-gzhandler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ob_gzhandler</refname>
  <refpurpose>ob_start callback function to gzip output buffer</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>ob_gzhandler</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>ob_gzhandler</function> is intended to be used as a callback
   function for <function>ob_start</function> to help facilitate sending
   gz-encoded data to web browsers that support compressed web pages.  
   Before <function>ob_gzhandler</function> actually sends compressed data,
   it determines what type of content encoding the browser will accept
   ("gzip", "deflate" or none at all) and will return its output accordingly.
   All browsers are supported since it's up to the browser to send the
   correct header saying that it accepts compressed web pages. If a browser
   doesn't support compressed pages this function returns &false;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ob_gzhandler</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

ob_start("ob_gzhandler");

?>
<html>
<body>
<p>This should be a compressed page.</p>
</body>
</html>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>ob_gzhandler</function> requires the <link linkend="ref.zlib">zlib</link> extension.
   </para>
  </note>
  <note>
   <para>
    You cannot use both <function>ob_gzhandler</function> and <link linkend="ini.zlib.output-compression">zlib.output_compression</link>.
    Also note that using <link linkend="ini.zlib.output-compression">
    zlib.output_compression</link> is preferred over
    <function>ob_gzhandler</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ob_start</function></member>
    <member><function>ob_end_flush</function></member>
   </simplelist>
  </para>
 </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
-->
