Filter/Compress/Rar.php

Show: PublicProtectedPrivateinherited
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: Rar.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Filter_Compress_Rar
jump to top

Package: Zend\Filter
Compression adapter for Rar
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

>VPropertyprotectedarray $_options = array('callback' => null, 'archive' => null, 'password' => null, 'target' => '.')
Compression Options array( 'callback' => Callback for compression 'archive' => Archive to use 'password' => Password to use 'target' => Target to write the files to )
Default valuearray('callback' => null, 'archive' => null, 'password' => null, 'target' => '.')Details
Type
array

Methods

methodpublic__construct(array $options = null) : void

Class constructor

Parameters
NameTypeDescription
$optionsarray

(Optional) Options to set

methodpubliccompress(string | array $content) : string

Compresses the given content

Parameters
NameTypeDescription
$contentstring | array
Returns
TypeDescription
string
methodpublicdecompress(string $content) : boolean

Decompresses the given content

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
boolean
methodpublicgetArchive() : string

Returns the set archive

Returns
TypeDescription
string
methodpublicgetCallback() : string

Returns the set callback for compression

Returns
TypeDescription
string
methodpublicgetOptions(string $option = null) : mixed
inherited

Returns one or all set options

Inherited from: \Zend_Filter_Compress_CompressAbstract::getOptions()
Parameters
NameTypeDescription
$optionstring

(Optional) Option to return

Returns
TypeDescription
mixed
methodpublicgetPassword() : string

Returns the set password

Returns
TypeDescription
string
methodpublicgetTarget() : string

Returns the set targetpath

Returns
TypeDescription
string
methodpublicsetArchive(string $archive) : \Zend_Filter_Compress_Rar

Sets the archive to use for de-/compression

Parameters
NameTypeDescription
$archivestring

Archive to use

Returns
TypeDescription
\Zend_Filter_Compress_Rar
methodpublicsetCallback(string $callback) : \Zend_Filter_Compress_Rar

Sets the callback to use

Parameters
NameTypeDescription
$callbackstring
Returns
TypeDescription
\Zend_Filter_Compress_Rar
methodpublicsetOptions(array $options) : \Zend_Filter_Compress_Bz2
inherited

Sets all or one option

Inherited from: \Zend_Filter_Compress_CompressAbstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Filter_Compress_Bz2
methodpublicsetPassword(string $password) : \Zend_Filter_Compress_Rar

Sets the password to use

Parameters
NameTypeDescription
$passwordstring
Returns
TypeDescription
\Zend_Filter_Compress_Rar
methodpublicsetTarget(string $target) : \Zend_Filter_Compress_Rar

Sets the targetpath to use

Parameters
NameTypeDescription
$targetstring
Returns
TypeDescription
\Zend_Filter_Compress_Rar
methodpublictoString() : string

Returns the adapter name

Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.