Class Gz

Summary

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

Description

Compression adapter for Gzip (ZLib)

Methods

Name Description Defined By
__construct() Class constructor Gz
compress() Compresses the given content Gz
decompress() Decompresses the given content Gz
getArchive() Returns the set archive Gz
getLevel() Returns the set compression level Gz
getMode() Returns the set compression mode Gz
getOptions() Returns one or all set options AbstractCompressionAlgorithm
setArchive() Sets the archive to use for de-/compression Gz
setLevel() Sets a new compression level Gz
setMode() Sets a new compression mode Gz
setOptions() Sets all or one option AbstractCompressionAlgorithm
toString() Returns the adapter name Gz

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

decompress()

Decompresses the given content

Parameter Name Type Description
$content string

Returns: string

getArchive()

Returns the set archive

Returns: string

getLevel()

Returns the set compression level

Returns: int

getMode()

Returns the set compression mode

Returns: string

getOptions()

Returns one or all set options

Parameter Name Type Description
$option string (Optional)

Returns: mixed

setArchive()

Sets the archive to use for de-/compression

Parameter Name Type Description
$archive string Archive

Returns: self

setLevel()

Sets a new compression level

Parameter Name Type Description
$level int

Returns: self

setMode()

Sets a new compression mode

Parameter Name Type Description
$mode string Supported

Returns: self

setOptions()

Sets all or one option

Parameter Name Type Description
$options array

Returns: self

toString()

Returns the adapter name

Returns: string

Top