Methods
Class constructor
__construct(null | array | \Traversable $options)
Parameters
$options
nullarray\Traversable(Optional) Options to set
Exceptions
Compresses the given content
compress(string $content) : string
Parameters
$content
string
Exceptions
Returns
string
Decompresses the given content
decompress(string $content) : string
Parameters
$content
string
Exceptions
Returns
string
Returns the set archive
getArchive() : string
Returns the set compression level
getLevel() : int
Returns the set compression mode
getMode() : string
Returns one or all set options
getOptions(string $option) : mixed
Inherited
| inherited_from |
\Zend\Filter\Compress\AbstractCompressionAlgorithm::getOptions() |
Parameters
$option
string(Optional) Option to return
Returns
mixed
Sets the archive to use for de-/compression
setArchive(string $archive) : \Zend\Filter\Compress\self
Parameters
$archive
stringArchive to use
Returns
\Zend\Filter\Compress\self
Sets a new compression level
setLevel(int $level) : \Zend\Filter\Compress\self
Parameters
$level
int
Exceptions
Returns
\Zend\Filter\Compress\self
Sets a new compression mode
setMode(string $mode) : \Zend\Filter\Compress\self
Parameters
$mode
stringSupported are 'compress', 'deflate' and 'file'
Exceptions
Returns
\Zend\Filter\Compress\self
Sets all or one option
setOptions(array $options) : \Zend\Filter\Compress\self
Inherited
| inherited_from |
\Zend\Filter\Compress\AbstractCompressionAlgorithm::setOptions() |
Parameters
$options
array
Returns
\Zend\Filter\Compress\self
Returns the adapter name
toString() : string
Properties
Compression Options
array(
'level' => Compression level 0-9
'mode' => Compression mode, can be 'compress', 'deflate'
'archive' => Archive to use
)
$options : array