Filter/Compress/CompressAbstract.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 [email protected] 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: CompressAbstract.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Filter_Compress_CompressAbstract

Package: Zend\Filter

Abstract compression adapter

Implements
\Zend_Filter_Compress_CompressInterface
Children
\Zend_Filter_Compress_Tar
\Zend_Filter_Compress_Zip
\Zend_Filter_Compress_Bz2
\Zend_Filter_Compress_Rar
\Zend_Filter_Compress_Gz
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

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

Class constructor

Parameters
Name Type Description
$options array | \Zend_Config

(Optional) Options to set

methodpubliccompress(string $value) : string
inherited

Compresses $value with the defined settings

Inherited from: \Zend_Filter_Compress_CompressInterface::compress()
Parameters
Name Type Description
$value string

Data to compress

Returns
Type Description
string The compressed data
methodpublicdecompress(string $value) : string
inherited

Decompresses $value with the defined settings

Inherited from: \Zend_Filter_Compress_CompressInterface::decompress()
Parameters
Name Type Description
$value string

Data to decompress

Returns
Type Description
string The decompressed data
methodpublicgetOptions(string $option = null) : mixed

Returns one or all set options

Parameters
Name Type Description
$option string

(Optional) Option to return

Returns
Type Description
mixed
methodpublicsetOptions(array $options) : \Zend_Filter_Compress_Bz2

Sets all or one option

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Filter_Compress_Bz2
methodpublictoString() : string
inherited

Return the adapter name

Inherited from: \Zend_Filter_Compress_CompressInterface::toString()
Returns
Type Description
string
Documentation was generated by phpDocumentor 2.0.0a8.