Class Tar

Summary

Fully Qualified Name: Zend\Filter\Compress\Tar
Extends: AbstractCompressionAlgorithm

Description

Compression adapter for Tar

Methods

Name Description Defined By
__construct() Class constructor Tar
compress() Compresses the given content Tar
decompress() Decompresses the given content Tar
getArchive() Returns the set archive Tar
getMode() Returns the set compression mode Tar
getOptions() Returns one or all set options AbstractCompressionAlgorithm
getTarget() Returns the set target path Tar
setArchive() Sets the archive to use for de-/compression Tar
setMode() Compression mode to use Tar
setOptions() Sets all or one option AbstractCompressionAlgorithm
setTarget() Sets the target path to use Tar
toString() Returns the adapter name Tar

Method Details

__construct()

Class constructor

Parameter Name Type Description
$options array (Optional)

Returns:

compress()

Compresses the given content

Parameter Name Type Description
$content string

Returns: string

decompress()

Decompresses the given content

Parameter Name Type Description
$content string

Returns: string

getArchive()

Returns the set archive

Returns: string

getMode()

Returns the set compression mode

Returns: string

getOptions()

Returns one or all set options

Parameter Name Type Description
$option string (Optional)

Returns: mixed

getTarget()

Returns the set target path

Returns: string

setArchive()

Sets the archive to use for de-/compression

Parameter Name Type Description
$archive string Archive

Returns: self

setMode()

Compression mode to use

Either Gz or Bz2.

Parameter Name Type Description
$mode string

Returns: self

setOptions()

Sets all or one option

Parameter Name Type Description
$options array

Returns: self

setTarget()

Sets the target path to use

Parameter Name Type Description
$target string

Returns: self

toString()

Returns the adapter name

Returns: string

Top