Zend Framework
Back to top  

Compresses a given string

 Methods

Calls adapter methods

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

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) 

Parameters

$options

stringarray\Traversable

(Optional) Options to set

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

inherited_from \Zend\Filter\AbstractFilter::__invoke()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Defined by Zend\Filter\FilterInterface

filter(string $value) : string

Compresses the content $value with the defined settings

Parameters

$value

string

Content to compress

Exceptions

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

Returns

stringThe compressed content

Returns the current adapter, instantiating it if necessary

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

Exceptions

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

Returns

\Zend\Filter\Compress\CompressionAlgorithmInterface

Retrieve adapter name

getAdapterName() : string

Returns

string

Retrieve adapter options

getAdapterOptions() : array

Returns

array

Get individual or all options from underlying adapter

getOptions(null | string $option) : mixed

Parameters

$option

nullstring

Returns

mixed

hasPcreUnicodeSupport() 

hasPcreUnicodeSupport() : bool
Inherited

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

Returns

bool

Sets compression adapter

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

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

Parameters

$options

array

Returns

\Zend\Filter\self

Set filter setate

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

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()

Parameters

$options

mixed

Returns

bool

 Properties

 

Compression adapter

$adapter 

 

Compression adapter constructor options

$adapterOptions 

 

Filter options

$options : array
Inherited

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