Navigation

Search

read_tgz_file

Description

Reads a .tar.gz file, filename, in and extracts file(s) from it.

Syntax

array read_tgz_file (string $gzfilename, void $destination[, bool $single_file[, bool $overwrite]])



Parameter $gzfilename

Expected type: String
Description: The name of the file to read



Parameter $destination

Expected type: Void
Description: Null to display a listing of files in the archive, the destination for the files in the archive or the name of a single file to display (if $single_file is true)



Parameter $single_file

Expected type: Boolean
Description: If true, displays the contents of the file specified by $destination, or false if the file doesn't exist (default is false)



Parameter $overwrite

Expected type: Boolean
Description: If true, overwrites existing files with newer modification times. Default is false.



Return value

Expected type: Array
Description:


Notes

  • Essentially just a shortcut for read_tgz_data().
View all versions of this function