php ob_gzhandler man page on unix.com

Php Man Pages All Man Pages Latest Topics Forum Categories

Query: ob_gzhandler

OS: php

Section: 3

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

OB_GZHANDLER(3) 							 1							   OB_GZHANDLER(3)

ob_gzhandler - ob_start callback function to gzip output buffer

SYNOPSIS
       string ob_gzhandler (string  $buffer, int  $mode)

DESCRIPTION
       ob_gzhandler(3)	is  intended  to be used as a callback function for ob_start(3) to help facilitate sending gz-encoded data to web browsers
       that support compressed web pages. Before ob_gzhandler(3) 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.

PARAMETERS
	      o $buffer
		-

	      o $mode
		-

RETURN VALUES
EXAMPLES
       Example #1

	      ob_gzhandler(3) example

	      <?php

	      ob_start("ob_gzhandler");

	      ?>
	      <html>
	      <body>
	      <p>This should be a compressed page.</p>
	      </body>
	      </html>

NOTES
       Note

	      ob_gzhandler(3) requires the zlib extension.

       Note

	       You  cannot  use  both ob_gzhandler(3) and zlib.output_compression. Also note that using  zlib.output_compression is preferred over
	      ob_gzhandler(3).

SEE ALSO
       ob_start(3), ob_end_flush(3).

PHP Documentation Group 													   OB_GZHANDLER(3)

php man page for ob_gzhandler