| package |
Default |
| inherited_from |
\Zend\Filter\Compress\AbstractCompressionAlgorithm |
Methods
Class constructor
__construct(null|array|\Traversable $options = null)
| inherited_from |
\Zend\Filter\Compress\AbstractCompressionAlgorithm::__construct() |
Parameters
$options
nullarray\Traversable(Optional) Options to set
Exceptions
\Zend\Filter\Exception\ExtensionNotLoadedException |
if zip extension not loaded |
Class constructor
__construct(null|array|\Traversable $options = null)
Inherited
Parameters
$options
nullarray\Traversable(Optional) Options to set
Compresses the given content
compress(string $content) : string
Parameters
$content
string
Exceptions
\Zend\Filter\Exception\RuntimeException |
if unable to open zip archive, or error during compression |
Returns
stringCompressed archive
Decompresses the given content
decompress(string $content) : string
Parameters
$content
string
Exceptions
\Zend\Filter\Exception\RuntimeException |
If archive file not found, target directory not found,
or error during decompression |
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 = null) : mixed
Inherited
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\Zip
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$archive
stringArchive to use
Returns
\Zend\Filter\Compress\Zip
Sets all or one option
setOptions(array $options) : \Zend\Filter\Compress\Zip
Inherited
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$options
array
Returns
\Zend\Filter\Compress\Zip
Sets the target to use
setTarget(string $target) : \Zend\Filter\Compress\Zip
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$target
string
Exceptions
\Zend\Filter\Exception\InvalidArgumentException |
|
Returns
\Zend\Filter\Compress\Zip
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
Default
array('archive' => null, 'target' => null)
| inherited_from |
\Zend\Filter\Compress\AbstractCompressionAlgorithm::options |
$options
$options : array