Compression adapter for Tar

category Zend
package Zend_Filter
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Filter_Compress_CompressAbstract

 Methods

Class constructor

__construct(array $options = null
inherited_from \Zend_Filter_Compress_CompressAbstract::__construct()

Parameters

$options

array

(Optional) Options to set

Class constructor

__construct(array|\Zend_Config $options = null
Inherited

Parameters

$options

array\Zend_Config

(Optional) Options to set

Compresses the given content

compress(string $content) : string

Parameters

$content

string

Returns

string

Decompresses the given content

decompress(string $content) : boolean

Parameters

$content

string

Returns

boolean

Returns the set archive

getArchive() : string

Returns

string

Returns the set compression mode

getMode() 

Returns one or all set options

getOptions(string $option = null) : mixed
Inherited

Parameters

$option

string

(Optional) Option to return

Returns

mixed

Returns the set targetpath

getTarget() : string

Returns

string

Sets the archive to use for de-/compression

setArchive(string $archive) : \Zend_Filter_Compress_Tar

Parameters

$archive

string

Archive to use

Returns

\Zend_Filter_Compress_Tar

Compression mode to use Eighter Gz or Bz2

setMode(string $mode) 

Parameters

$mode

string

Sets all or one option

setOptions(array $options) : \Zend_Filter_Compress_Bz2
Inherited

Parameters

$options

array

Returns

\Zend_Filter_Compress_Bz2

Sets the targetpath to use

setTarget(string $target) : \Zend_Filter_Compress_Tar

Parameters

$target

string

Returns

\Zend_Filter_Compress_Tar

Returns the adapter name

toString() : string

Returns

string

 Properties

 

Compression Options array( 'archive' => Archive to use 'target' => Target to write the files to )

$_options : array

Default

array('archive' => null, 'target' => '.', 'mode' => null)