Filter/Compress.php
inherited
Classes
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: Compress.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Filter_Compress
Compresses a given string
- Implements
- \Zend_Filter_Interface
- Children
- \Zend_Filter_Decompress
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
$_adapter = 'Gz'Compression adapter
'Gz'Details- Type
- n/a
$_adapterOptions = array()Compression adapter constructor options
array()Details- Type
- n/a
Methods
__call(string $method, string | array $options) : voidCalls adapter methods
| Name | Type | Description |
|---|---|---|
| $method | string | Method to call |
| $options | string | array | Options for this method |
__construct(string | array $options = null) : voidClass constructor
| Name | Type | Description |
|---|---|---|
| $options | string | array | (Optional) Options to set |
filter(string $value) : stringDefined by Zend_Filter_Interface
Compresses the content $value with the defined settings
| Name | Type | Description |
|---|---|---|
| $value | string | Content to compress |
| Type | Description |
|---|---|
| string | The compressed content |
| Exception | Description |
|---|---|
| \Zend_Filter_Exception | If filtering $value is impossible |
getAdapter() : stringReturns the current adapter, instantiating it if necessary
| Type | Description |
|---|---|
| string |
getAdapterName() : stringRetrieve adapter name
| Type | Description |
|---|---|
| string |
getAdapterOptions() : arrayRetrieve adapter options
| Type | Description |
|---|---|
| array |
setAdapter(string | \Zend_Filter_Compress_CompressInterface $adapter) : \Zend_Filter_CompressSets compression adapter
| Name | Type | Description |
|---|---|---|
| $adapter | string | \Zend_Filter_Compress_CompressInterface | Adapter to use |
| Type | Description |
|---|---|
| \Zend_Filter_Compress |
setAdapterOptions(array $options) : voidSet adapter options
| Name | Type | Description |
|---|---|---|
| $options | array |
setOptions(array $options) : \Zend_Filter_CompressSet filter setate
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Filter_Compress |