Function __global->compress_cms_stub_file

Definitions

sources/web_resources2.php

  • Compress a file to Gzip, and save with a stem of .gz.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$stub_file PATH No No required parameter N/A N/A Full path to the file to compress

Returns

  • Success status
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Compress a file to Gzip, and save with a stem of .gz.
 *
 * @param  PATH $stub_file Full path to the file to compress
 * @return boolean Success status
 */
function compress_cms_stub_file(string $stub_file) : bool