Zend Framework
Back to top  

Decompresses a given string

 Methods

Calls adapter methods

__call(string $method, string | array $options) : mixed
Inherited

inherited_from \Zend\Filter\Compress::__call()

Parameters

$method

string

Method to call

$options

stringarray

Options for this method

Exceptions

\Zend\Filter\Exception\BadMethodCallException

Returns

mixed

Class constructor

__construct(string | array | \Traversable $options) 
Inherited

inherited_from \Zend\Filter\Compress::__construct()

Parameters

$options

stringarray\Traversable

(Optional) Options to set

Use filter as functor

__invoke(string $value) : string

Decompresses the content $value with the defined settings

Parameters

$value

string

Content to decompress

Exceptions

\Zend\Filter\Exception\ExceptionInterface If filtering $value is impossible

Returns

stringThe decompressed content

Defined by FilterInterface

filter(string $value) : string

Decompresses the content $value with the defined settings

Parameters

$value

string

Content to decompress

Exceptions

\Zend\Filter\Exception\RuntimeException If filtering $value is impossible

Returns

stringThe decompressed content

Returns the current adapter, instantiating it if necessary

getAdapter() : \Zend\Filter\Compress\CompressionAlgorithmInterface
Inherited

inherited_from \Zend\Filter\Compress::getAdapter()

Exceptions

\Zend\Filter\Exception\RuntimeException
\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\Compress\CompressionAlgorithmInterface

Retrieve adapter name

getAdapterName() : string
Inherited

inherited_from \Zend\Filter\Compress::getAdapterName()

Returns

string

Retrieve adapter options

getAdapterOptions() : array
Inherited

inherited_from \Zend\Filter\Compress::getAdapterOptions()

Returns

array

Get individual or all options from underlying adapter

getOptions(null | string $option) : mixed
Inherited

inherited_from \Zend\Filter\Compress::getOptions()

Parameters

$option

nullstring

Returns

mixed

hasPcreUnicodeSupport() 

hasPcreUnicodeSupport() : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()
inherited_from \Zend\Filter\Compress::hasPcreUnicodeSupport()

Returns

bool

Sets compression adapter

setAdapter(string | \Zend\Filter\Compress\CompressionAlgorithmInterface $adapter) : \Zend\Filter\self
Inherited

inherited_from \Zend\Filter\Compress::setAdapter()

Parameters

$adapter

string\Zend\Filter\Compress\CompressionAlgorithmInterface

Adapter to use

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\self

Set adapter options

setAdapterOptions(array $options) : \Zend\Filter\self
Inherited

inherited_from \Zend\Filter\Compress::setAdapterOptions()

Parameters

$options

array

Returns

\Zend\Filter\self

Set filter setate

setOptions(array $options) : \Zend\Filter\self
Inherited

inherited_from \Zend\Filter\Compress::setOptions()

Parameters

$options

array

Exceptions

\Zend\Filter\Exception\InvalidArgumentException if options is not an array or Traversable

Returns

\Zend\Filter\self

isOptions() 

isOptions(mixed $options) : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::isOptions()
inherited_from \Zend\Filter\Compress::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Compression adapter

$adapter 
Inherited

inherited_from \Zend\Filter\Compress::$$adapter
 

Compression adapter constructor options

$adapterOptions 
Inherited

inherited_from \Zend\Filter\Compress::$$adapterOptions
 

Filter options

$options : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::$$options
inherited_from \Zend\Filter\Compress::$$options