<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-gzhandler">
<refnamediv>
<refname>ob_gzhandler</refname>
<refpurpose>
ob_start callback function to gzip output buffer
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ob_gzhandler</methodname>
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<note>
<para>
<parameter>mode</parameter> was added in PHP 4.0.5.
</para>
</note>
<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 it's 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.
</para>
<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.
</html>
<body>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>ob_start</function> and
<function>ob_end_flush</function>.
</para>
<note>
<para>
You cannot use both <function>ob_gzhandler</function> and
<link linkend="ini.zlib.output-compression">
ini.zlib.output_compression</link>. Also note that
using <link linkend="ini.zlib.output-compression">
ini.zlib.output_compression</link> is preferred over
<function>ob_gzhandler</function>.
</para>
</note>
</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:"../../../../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
-->