Filter/Compress/CompressAbstract.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Filter
- Version
- $Id: CompressAbstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Filter_Compress_CompressAbstract
Package: Zend\Filter
Abstract compression adapter
- Implements
- \Zend_Filter_Compress_CompressInterface
- Children
- \Zend_Filter_Compress_Tar
- \Zend_Filter_Compress_Zip
- \Zend_Filter_Compress_Bz2
- \Zend_Filter_Compress_Rar
- \Zend_Filter_Compress_Gz
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods


__construct(array | \Zend_Config $options = null) : void
Class constructor
Parameters
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config | (Optional) Options to set |


compress(string $value) : string
inherited
Compresses $value with the defined settings
Inherited from: \Zend_Filter_Compress_CompressInterface::compress()
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | string | Data to compress |
Type | Description |
---|---|
string | The compressed data |


decompress(string $value) : string
inherited
Decompresses $value with the defined settings
Inherited from: \Zend_Filter_Compress_CompressInterface::decompress()
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | string | Data to decompress |
Type | Description |
---|---|
string | The decompressed data |


getOptions(string $option = null) : mixed
Returns one or all set options
Parameters
Returns
Name | Type | Description |
---|---|---|
$option | string | (Optional) Option to return |
Type | Description |
---|---|
mixed |


setOptions(array $options) : \Zend_Filter_Compress_Bz2
Sets all or one option
Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Filter_Compress_Bz2 |


toString() : string
inherited
Return the adapter name
Inherited from: \Zend_Filter_Compress_CompressInterface::toString()
Returns
Type | Description |
---|---|
string |