Function __global->cms_gzencode

Definitions

sources/output_compression.php

  • Compress via Gzip. Assumes support_gzip has been called to check in advance.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$in string No No required parameter N/A N/A Data to compress
$level integer No No required parameter N/A 0 9 Compression level

Returns

  • Compressed data (false: error)
  • Type: ~string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Compress via Gzip. Assumes support_gzip has been called to check in advance.
 *
 * @param  string $in Data to compress
 * @param  integer $level Compression level
 * @range 0 9
 * @return ~string Compressed data (false: error)
 */
function cms_gzencode(string $in, int $level)