Filter/Compress.php

Show:

inherited

Classes
- \Zend_Filter_Compress

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: Compress.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_Compress
jump to top

Package: Zend\Filter

Compresses a given string

Implements: \Zend_Filter_Interface
Children: \Zend_Filter_Decompress
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

$_adapter = 'Gz'

Compression adapter

Default value'Gz'Details

Type: n/a

$_adapterOptions = array()

Compression adapter constructor options

Default valuearray()Details

Type: n/a

Methods

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

Calls adapter methods

Parameters

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

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

Class constructor

Parameters

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

filter(string $value) : string

Defined by Zend_Filter_Interface

Compresses the content $value with the defined settings

Parameters

Name	Type	Description
$value	string	Content to compress

Returns

Type	Description
string	The compressed content

Throws

Exception	Description
\Zend_Filter_Exception	If filtering $value is impossible

getAdapter() : string

Returns the current adapter, instantiating it if necessary

Returns

Type	Description
string

getAdapterName() : string

Retrieve adapter name

Returns

Type	Description
string

getAdapterOptions() : array

Retrieve adapter options

Returns

Type	Description
array

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

Sets compression adapter

Parameters

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

Returns

Type	Description
\Zend_Filter_Compress

setAdapterOptions(array $options) : void

Set adapter options

Parameters

Name	Type	Description
$options	array

setOptions(array $options) : \Zend_Filter_Compress

Set filter setate

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Filter_Compress

Filter/Compress.php

\Zend_Filter_Compressjump to top

Properties

Methods

\Zend_Filter_Compress
jump to top