Filter/Decompress.php

Show: inherited
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 [email protected] 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

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

Propertyprotected$_adapter = 'Gz'
inherited

Compression adapter

Inherited from: \Zend_Filter_Compress::$$_adapter
Default value'Gz'Details
Type
n/a
Inherited_from
\Zend_Filter_Compress::$$_adapter  
Propertyprotected$_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

methodpublic__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

methodpublic__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

methodpublicfilter(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
methodpublicgetAdapter() : string
inherited

Returns the current adapter, instantiating it if necessary

Inherited from: \Zend_Filter_Compress::getAdapter()
Returns
Type Description
string
methodpublicgetAdapterName() : string
inherited

Retrieve adapter name

Inherited from: \Zend_Filter_Compress::getAdapterName()
Returns
Type Description
string
methodpublicgetAdapterOptions() : array
inherited

Retrieve adapter options

Inherited from: \Zend_Filter_Compress::getAdapterOptions()
Returns
Type Description
array
methodpublicsetAdapter(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
methodpublicsetAdapterOptions(array $options) : void
inherited

Set adapter options

Inherited from: \Zend_Filter_Compress::setAdapterOptions()
Parameters
Name Type Description
$options array
methodpublicsetOptions(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
Documentation was generated by phpDocumentor 2.0.0a8.