| Fully Qualified Name: | Zend\Filter\Compress |
| Extends: | AbstractFilter |
Compresses a given string
| Name | Description | Defined By |
|---|---|---|
| __call() | Calls adapter methods | Compress |
| __construct() | Class constructor | Compress |
| __invoke() | Invoke filter as a command | AbstractFilter |
| filter() | Defined by Zend\Filter\FilterInterface | Compress |
| getAdapter() | Returns the current adapter, instantiating it if necessary | Compress |
| getAdapterName() | Retrieve adapter name | Compress |
| getAdapterOptions() | Retrieve adapter options | Compress |
| getOptions() | Get individual or all options from underlying adapter | Compress |
| hasPcreUnicodeSupport() | AbstractFilter | |
| setAdapter() | Sets compression adapter | Compress |
| setAdapterOptions() | Set adapter options | Compress |
| setOptions() | Set filter setate | Compress |
Calls adapter methods
| Parameter Name | Type | Description |
|---|---|---|
| $method | string | Method |
| $options | string|array | Options |
Returns: mixed
Class constructor
| Parameter Name | Type | Description |
|---|---|---|
| $options | string|array|\Traversable | (Optional) |
Returns:
Invoke filter as a command
Proxies to {@link filter()}
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: mixed
Defined by Zend\Filter\FilterInterface
Compresses the content $value with the defined settings
| Parameter Name | Type | Description |
|---|---|---|
| $value | string | Content |
Returns: string The compressed content
Returns the current adapter, instantiating it if necessary
Returns: \Compress\CompressionAlgorithmInterface
Retrieve adapter name
Returns: string
Retrieve adapter options
Returns: array
Get individual or all options from underlying adapter
| Parameter Name | Type | Description |
|---|---|---|
| $option | null|string |
Returns: mixed
Returns: bool
Sets compression adapter
| Parameter Name | Type | Description |
|---|---|---|
| $adapter | string|\Compress\CompressionAlgorithmInterface | Adapter |
Returns: self
Set adapter options
| Parameter Name | Type | Description |
|---|---|---|
| $options | array |
Returns: self
Set filter setate
| Parameter Name | Type | Description |
|---|---|---|
| $options | array |
Returns: self