Zend Framework » \Zend\Filter\Compress\Bz2

Compression adapter for Bz2

Methods

Class constructor

__construct(null | array | \Traversable $options)

Parameters

$options

nullarray\Traversable

(Optional) Options to set

Exceptions

`\Zend\Filter\Exception\ExtensionNotLoadedException`	if bz2 extension not loaded

Compresses the given content

compress(string $content) : string

Parameters

$content

string

Exceptions

`\Zend\Filter\Exception\RuntimeException`

Returns

string

Decompresses the given content

decompress(string $content) : string

Parameters

$content

string

Exceptions

`\Zend\Filter\Exception\RuntimeException`

Returns

string

Returns the set archive

getArchive() : string

Returns

string

Returns the set blocksize

getBlocksize() : integer

Returns

integer

Returns one or all set options

getOptions(string $option) : mixed

Inherited

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

Parameters

$option

string

(Optional) Option to return

Returns

mixed

Sets the archive to use for de-/compression

setArchive(string $archive) : \Zend\Filter\Compress\Bz2

Parameters

$archive

string

Archive to use

Returns

\Zend\Filter\Compress\Bz2

Sets a new blocksize

setBlocksize(integer $blocksize) : \Zend\Filter\Compress\Bz2

Parameters

$blocksize

integer

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\Compress\Bz2

Sets all or one option

setOptions(array $options) : \Zend\Filter\Compress\AbstractCompressionAlgorithm

Inherited

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

Parameters

$options

array

Returns

\Zend\Filter\Compress\AbstractCompressionAlgorithm

Returns the adapter name

toString() : string

Returns

string

Properties

Compression Options array( 'blocksize' => Blocksize to use from 0-9 'archive' => Archive to use )

$options : array