Filter/Decompress.php

Show:

inherited

Classes
- \Zend_Filter_Decompress

Table of Contents

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 license@zend.com 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: Decompress.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_Decompress
jump to top

Package: Zend\Filter

Decompresses a given string

Parent(s): \Zend_Filter_Compress
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

$_adapter = 'Gz'

inherited

Compression adapter

Inherited from: \Zend_Filter_Compress::$$_adapter

Default value'Gz'Details

Type: n/a
Inherited_from: \Zend_Filter_Compress::$$_adapter

$_adapterOptions = array()

inherited

Compression adapter constructor options

Inherited from: \Zend_Filter_Compress::$$_adapterOptions

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Filter_Compress::$$_adapterOptions

Methods

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

inherited

Calls adapter methods

Inherited from: \Zend_Filter_Compress::__call()

Parameters

Name	Type	Description
$method	string	Method to call
$options	string \| array	Options for this method

__construct(string | array $options = null) : void

inherited

Class constructor

Inherited from: \Zend_Filter_Compress::__construct()

Parameters

Name	Type	Description
$options	string \| array	(Optional) Options to set

filter(string $value) : string

Defined by Zend_Filter_Interface

Decompresses the content $value with the defined settings

Parameters

Name	Type	Description
$value	string	Content to decompress

Returns

Type	Description
string	The decompressed content

Throws

Exception	Description
\Zend_Filter_Exception	If filtering $value is impossible

getAdapter() : string

inherited

Returns the current adapter, instantiating it if necessary

Inherited from: \Zend_Filter_Compress::getAdapter()

Returns

Type	Description
string

getAdapterName() : string

inherited

Retrieve adapter name

Inherited from: \Zend_Filter_Compress::getAdapterName()

Returns

Type	Description
string

getAdapterOptions() : array

inherited

Retrieve adapter options

Inherited from: \Zend_Filter_Compress::getAdapterOptions()

Returns

Type	Description
array

setAdapter(string | \Zend_Filter_Compress_CompressInterface $adapter) : \Zend_Filter_Compress

inherited

Sets compression adapter

Inherited from: \Zend_Filter_Compress::setAdapter()

Parameters

Name	Type	Description
$adapter	string \| \Zend_Filter_Compress_CompressInterface	Adapter to use

Returns

Type	Description
\Zend_Filter_Compress

setAdapterOptions(array $options) : void

inherited

Set adapter options

Inherited from: \Zend_Filter_Compress::setAdapterOptions()

Parameters

Name	Type	Description
$options	array

setOptions(array $options) : \Zend_Filter_Compress

inherited

Set filter setate

Inherited from: \Zend_Filter_Compress::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Filter_Compress

Filter/Decompress.php

\Zend_Filter_Decompressjump to top

Properties

Methods

\Zend_Filter_Decompress
jump to top