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
stringCompressed archive
Decompresses the given content
decompress(string $content) : string
Parameters
$content
string
Exceptions
Returns
string
Returns the proper string based on the given error constant
errorString(string $error) : string
Parameters
$error
string
Returns
string
Returns the set archive
getArchive() : 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
Returns the set targetpath
getTarget() : string
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 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
Sets the target to use
setTarget(string $target) : \Zend\Filter\Compress\self
Parameters
$target
string
Exceptions
Returns
\Zend\Filter\Compress\self
Returns the adapter name
toString() : string
Properties
Compression Options
array(
'archive' => Archive to use
'password' => Password to use
'target' => Target to write the files to
)
$options : array