API Documentation

Zend/Filter/Compress.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 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Filter_Compress

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

Propertyprotected  $_adapter= ''Gz''

Compression adapter

Default value'Gz'Details
Type
Propertyprotected  $_adapterOptions= 'array()'

Compression adapter constructor options

Default valuearray()Details
Type

Methods

methodpublic__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

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

Class constructor

Parameters
Name Type Description
$options string|array

(Optional) Options to set

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

Returns the current adapter, instantiating it if necessary

Returns
Type Description
string
methodpublicgetAdapterName( ) : string

Retrieve adapter name

Returns
Type Description
string
methodpublicgetAdapterOptions( ) : array

Retrieve adapter options

Returns
Type Description
array
methodpublicsetAdapter( 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
methodpublicsetAdapterOptions( array $options ) : void

Set adapter options

Parameters
Name Type Description
$options array
methodpublicsetOptions( array $options ) : \Zend_Filter_Compress

Set filter setate

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Filter_Compress
Documentation was generated by DocBlox 0.15.1.