API Documentation

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

\Zend_Filter_Compress_Zip

Package: Zend\Filter

Compression adapter for zip

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( 'archive' => null'

Compression Options array( 'archive' => Archive to use 'password' => Password to use 'target' => Target to write the files to )

Default valuearray( 'archive' => nullDetails
Type
array

Methods

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

Class constructor

Parameters
Name Type Description
$options string|array

(Optional) Options to set

methodprotected_errorString( string $error ) : void

Returns the proper string based on the given error constant

Parameters
Name Type Description
$error string
methodpubliccompress( string $content ) : string

Compresses the given content

Parameters
Name Type Description
$content string
Returns
Type Description
string Compressed archive
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
methodpublicgetTarget( ) : string

Returns the set targetpath

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

Sets the archive to use for de-/compression

Parameters
Name Type Description
$archive string

Archive to use

Returns
Type Description
\Zend_Filter_Compress_Rar
methodpublicsetTarget( string $target ) : \Zend_Filter_Compress_Rar

Sets the target to use

Parameters
Name Type Description
$target string
Returns
Type Description
\Zend_Filter_Compress_Rar
methodpublictoString( ) : string

Returns the adapter name

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.