Class Zip

Summary

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

Description

Compression adapter for zip

Methods

Name Description Defined By
__construct() Class constructor Zip
compress() Compresses the given content Zip
decompress() Decompresses the given content Zip
errorString() Returns the proper string based on the given error constant Zip
getArchive() Returns the set archive Zip
getOptions() Returns one or all set options AbstractCompressionAlgorithm
getTarget() Returns the set targetpath Zip
setArchive() Sets the archive to use for de-/compression Zip
setOptions() Sets all or one option AbstractCompressionAlgorithm
setTarget() Sets the target to use Zip
toString() Returns the adapter name Zip

Method Details

__construct()

Class constructor

Parameter Name Type Description
$options null|array|\Traversable (Optional)

Returns:

compress()

Compresses the given content

Parameter Name Type Description
$content string

Returns: string Compressed archive

decompress()

Decompresses the given content

Parameter Name Type Description
$content string

Returns: string

errorString()

Returns the proper string based on the given error constant

Parameter Name Type Description
$error string

Returns: string

getArchive()

Returns the set archive

Returns: string

getOptions()

Returns one or all set options

Parameter Name Type Description
$option string (Optional)

Returns: mixed

getTarget()

Returns the set targetpath

Returns: string

setArchive()

Sets the archive to use for de-/compression

Parameter Name Type Description
$archive string Archive

Returns: self

setOptions()

Sets all or one option

Parameter Name Type Description
$options array

Returns: self

setTarget()

Sets the target to use

Parameter Name Type Description
$target string

Returns: self

toString()

Returns the adapter name

Returns: string

Top