API Documentation

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

\Zend_Filter_Compress_Gz

Package: Zend\Filter

Compression adapter for Gzip (ZLib)

Parent(s)
\Zend_Filter_Compress_CompressAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_options= 'array( 'level' => 9'

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

Default valuearray( 'level' => 9Details
Type
array

Methods

methodpublic__construct( array|\Zend_Config|null $options = null ) : void

Class constructor

Parameters
Name Type Description
$options array|\Zend_Config|null

(Optional) Options to set

methodpubliccompress( string $content ) : string

Compresses the given content

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicdecompress( string $content ) : string

Decompresses the given content

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicgetArchive( ) : string

Returns the set archive

Returns
Type Description
string
methodpublicgetLevel( ) : integer

Returns the set compression level

Returns
Type Description
integer
methodpublicgetMode( ) : string

Returns the set compression mode

Returns
Type Description
string
methodpublicsetArchive( string $archive ) : \Zend_Filter_Compress_Gz

Sets the archive to use for de-/compression

Parameters
Name Type Description
$archive string

Archive to use

Returns
Type Description
\Zend_Filter_Compress_Gz
methodpublicsetLevel( integer $level ) : \Zend_Filter_Compress_Gz

Sets a new compression level

Parameters
Name Type Description
$level integer
Returns
Type Description
\Zend_Filter_Compress_Gz
methodpublicsetMode( string $mode ) : void

Sets a new compression mode

Parameters
Name Type Description
$mode string

Supported are 'compress', 'deflate' and 'file'

methodpublictoString( ) : string

Returns the adapter name

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.