phpBB API Documentation
Class

compress_tar

class compress_tar extends compress

Tar/tar.gz compression routine Header/checksum creation derived from tarfile.pl, (c) Tom Horsley, 1994

Properties

$fp
$isgz
$isbz
$filename
$mode
$type
$wrote

Methods

add_file($src, $src_rm_prefix = '', $src_add_prefix = '', $skip_files = '')

Add file to archive

from compress
add_custom_file($src, $filename)

Add custom file (the filepath will not be adjusted)

from compress
add_data($src, $name)

Add file data

from compress
static array methods()

Return available methods

from compress
compress_tar($mode, $file, $type = '')

Constructor

extract($dst)

Extract archive

close()

Close archive

data($name, $data, $stat, $is_dir = false)

Create the structures

open()

Open archive

download($filename, $download_name = false)

Download archive

Details

in compress at line 37
public add_file($src, $src_rm_prefix = '', $src_add_prefix = '', $skip_files = '')

Add file to archive

Parameters

$src
$src_rm_prefix
$src_add_prefix
$skip_files

in compress at line 107
public add_custom_file($src, $filename)

Add custom file (the filepath will not be adjusted)

Parameters

$src
$filename

in compress at line 121
public add_data($src, $name)

Add file data

Parameters

$src
$name

in compress at line 167
static public array methods()

Return available methods

Return Value

array Array of strings of available compression methods (.tar, .tar.gz, .zip, etc.)

at line 572
public compress_tar($mode, $file, $type = '')

Constructor

Parameters

$mode
$file
$type

at line 591
public extract($dst)

Extract archive

Parameters

$dst

at line 709
public close()

Close archive

at line 727
public data($name, $data, $stat, $is_dir = false)

Create the structures

Parameters

$name
$data
$stat
$is_dir

at line 774
public open()

Open archive

at line 788
public download($filename, $download_name = false)

Download archive

Parameters

$filename
$download_name