API Documentation

Filter/Compress.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
version
$Id: Compress.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Filter_Compress

Description

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.

Zend_Filter_Compress

Implements
Zend_Filter_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
Properties
$_adapter
$_adapterOptions
Methods
__construct
setOptions
getAdapter
getAdapterName
setAdapter
getAdapterOptions
setAdapterOptions
__call
filter

Description

Compresses a given string

Properties

$_adapter

 $_adapter = 'Gz'

Compression adapter

Details

visibility
protected
default
Gz
final
false
static
false

$_adapterOptions

 $_adapterOptions = 'array'

Compression adapter constructor options

Details

visibility
protected
default
array
final
false
static
false

Methods

__call

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

Calls adapter methods

Arguments
$method
string
Method to call
$options
stringarray
Options for this method
Details
visibility
public
final
false
static
false

__construct

__construct( string|array $options = null ) :

Class constructor

Arguments
$options
stringarray
(Optional) Options to set
Details
visibility
public
final
false
static
false

filter

filter( string $value ) : string

Defined by Zend_Filter_Interface

Compresses the content $value with the defined settings

Arguments
$value
string
Content to compress
Output
string
The compressed content
Details
visibility
public
final
false
static
false

getAdapter

getAdapter( ) : string

Returns the current adapter, instantiating it if necessary

Output
string
Details
visibility
public
final
false
static
false

getAdapterName

getAdapterName( ) : string

Retrieve adapter name

Output
string
Details
visibility
public
final
false
static
false

getAdapterOptions

getAdapterOptions( ) : array

Retrieve adapter options

Output
array
Details
visibility
public
final
false
static
false

setAdapter

setAdapter( string|Zend_Filter_Compress_CompressInterface $adapter ) : Zend_Filter_Compress

Sets compression adapter

Arguments
$adapter
stringZend_Filter_Compress_CompressInterface
Adapter to use
Details
visibility
public
final
false
static
false

setAdapterOptions

setAdapterOptions( array $options ) : void

Set adapter options

Arguments
$options
array
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Filter_Compress

Set filter setate

Arguments
$options
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.