API Documentation

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

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_Rar

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
getCallback
setCallback
getArchive
setArchive
getPassword
setPassword
getTarget
setTarget
compress
decompress
toString

Description

Compression adapter for Rar

Properties

$_options

array $_options = 'array'

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

Details

$_options
array
visibility
protected
default
array
final
false
static
false

Methods

__construct

__construct( array $options = null ) :

Class constructor

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

compress

compress( string|array $content ) : string

Compresses the given content

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

decompress

decompress( string $content ) : boolean

Decompresses the given content

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

getArchive

getArchive( ) : string

Returns the set archive

Output
string
Details
visibility
public
final
false
static
false

getCallback

getCallback( ) : string

Returns the set callback for compression

Output
string
Details
visibility
public
final
false
static
false

getPassword

getPassword( ) : string

Returns the set password

Output
string
Details
visibility
public
final
false
static
false

getTarget

getTarget( ) : string

Returns the set targetpath

Output
string
Details
visibility
public
final
false
static
false

setArchive

setArchive( string $archive ) : Zend_Filter_Compress_Rar

Sets the archive to use for de-/compression

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

setCallback

setCallback( string $callback ) : Zend_Filter_Compress_Rar

Sets the callback to use

Arguments
$callback
string
Details
visibility
public
final
false
static
false

setPassword

setPassword( string $password ) : Zend_Filter_Compress_Rar

Sets the password to use

Arguments
$password
string
Details
visibility
public
final
false
static
false

setTarget

setTarget( string $target ) : Zend_Filter_Compress_Rar

Sets the targetpath to use

Arguments
$target
string
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.