API Documentation

Filter/Compress/Gz.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: Gz.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Filter_Compress_Gz

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_Gz

Extends from
Zend_Filter_Compress_CompressAbstract
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
$_options
Methods
__construct
getLevel
setLevel
getMode
setMode
getArchive
setArchive
compress
decompress
toString

Description

Compression adapter for Gzip (ZLib)

Properties

$_options

array $_options = 'array'

Compression Options array( 'level' => Compression level 0-9 'mode' => Compression mode, can be 'compress', 'deflate' 'archive' => Archive to use )

Details

$_options
array
visibility
protected
default
array
final
false
static
false

Methods

__construct

__construct( array|Zend_Config|null $options = null ) :

Class constructor

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

compress

compress( string $content ) : string

Compresses the given content

Arguments
$content
string
Output
string
Details
visibility
public
final
false
static
false

decompress

decompress( string $content ) : string

Decompresses the given content

Arguments
$content
string
Output
string
Details
visibility
public
final
false
static
false

getArchive

getArchive( ) : string

Returns the set archive

Output
string
Details
visibility
public
final
false
static
false

getLevel

getLevel( ) : integer

Returns the set compression level

Output
integer
Details
visibility
public
final
false
static
false

getMode

getMode( ) : string

Returns the set compression mode

Output
string
Details
visibility
public
final
false
static
false

setArchive

setArchive( string $archive ) : Zend_Filter_Compress_Gz

Sets the archive to use for de-/compression

Arguments
$archive
string
Archive to use
Details
visibility
public
final
false
static
false

setLevel

setLevel( integer $level ) : Zend_Filter_Compress_Gz

Sets a new compression level

Arguments
$level
integer
Details
visibility
public
final
false
static
false

setMode

setMode( string $mode ) :

Sets a new compression mode

Arguments
$mode
string
Supported are 'compress', 'deflate' and 'file'
Details
visibility
public
final
false
static
false

toString

toString( ) : string

Returns the adapter name

Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.