Filter/Compress/Rar.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Filter
- Version
- $Id$
\Zend_Filter_Compress_Rar
Package: Zend_Filter
Compression adapter for Rar
- Parent(s)
- \Zend_Filter_Compress_CompressAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_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 value
array('callback' => null, 'archive' => null, 'password' => null, 'target' => '.')Details- Type
- array
Methods
__construct(array $options = null) : voidClass constructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | array | (Optional) Options to set |
compress(string | array $content) : stringCompresses the given content
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $content | string | array |
| Type | Description |
|---|---|
| string |
decompress(string $content) : booleanDecompresses the given content
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| boolean |
getArchive() : stringReturns the set archive
Returns
| Type | Description |
|---|---|
| string |
getCallback() : stringReturns the set callback for compression
Returns
| Type | Description |
|---|---|
| string |
getPassword() : stringReturns the set password
Returns
| Type | Description |
|---|---|
| string |
getTarget() : stringReturns the set targetpath
Returns
| Type | Description |
|---|---|
| string |
setArchive(string $archive) : \Zend_Filter_Compress_RarSets the archive to use for de-/compression
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $archive | string | Archive to use |
| Type | Description |
|---|---|
| \Zend_Filter_Compress_Rar |
setCallback(string $callback) : \Zend_Filter_Compress_RarSets the callback to use
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $callback | string |
| Type | Description |
|---|---|
| \Zend_Filter_Compress_Rar |
setPassword(string $password) : \Zend_Filter_Compress_RarSets the password to use
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $password | string |
| Type | Description |
|---|---|
| \Zend_Filter_Compress_Rar |
setTarget(string $target) : \Zend_Filter_Compress_RarSets the targetpath to use
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $target | string |
| Type | Description |
|---|---|
| \Zend_Filter_Compress_Rar |
toString() : stringReturns the adapter name
Returns
| Type | Description |
|---|---|
| string |