Filter/Compress.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Filter  
Version
$Id$  

\Zend_Filter_Compress

Package: Zend_Filter
Compresses a given string
Implements
Children
\Zend_Filter_Decompress
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_adapter = 'Gz'
Compression adapter
Default value'Gz'Details
Type
n/a
>VPropertyprotected$_adapterOptions = array()
Compression adapter constructor options
Default valuearray()Details
Type
n/a

Methods

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

Calls adapter methods

Parameters
NameTypeDescription
$methodstring

Method to call

$optionsstring | array

Options for this method

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

Class constructor

Parameters
NameTypeDescription
$optionsstring | array

(Optional) Options to set

methodpublicfilter(string $value) : string

Defined by Zend_Filter_Interface

Compresses the content $value with the defined settings
Parameters
NameTypeDescription
$valuestring

Content to compress

Returns
TypeDescription
stringThe compressed content
methodpublicgetAdapter() : string

Returns the current adapter, instantiating it if necessary

Returns
TypeDescription
string
methodpublicgetAdapterName() : string

Retrieve adapter name

Returns
TypeDescription
string
methodpublicgetAdapterOptions() : array

Retrieve adapter options

Returns
TypeDescription
array
methodpublicsetAdapter(string | \Zend_Filter_Compress_CompressInterface $adapter) : \Zend_Filter_Compress

Sets compression adapter

Parameters
NameTypeDescription
$adapterstring | \Zend_Filter_Compress_CompressInterface

Adapter to use

Returns
TypeDescription
\Zend_Filter_Compress
methodpublicsetAdapterOptions(array $options) : void

Set adapter options

Parameters
NameTypeDescription
$optionsarray
methodpublicsetOptions(array $options) : \Zend_Filter_Compress

Set filter setate

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Filter_Compress
Documentation was generated by phpDocumentor 2.2.0 .