Filter/Compress/Tar.php

Show:

inherited

Classes
- \Zend_Filter_Compress_Tar

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

\Zend_Filter_Compress_Tar
jump to top

Package: Zend\Filter

Compression adapter for Tar

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

array $_options = array('archive' => null, 'target' => '.', 'mode' => null)

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

Default valuearray('archive' => null, 'target' => '.', 'mode' => null)Details

Type: array

Methods

__construct(array $options = null) : void

Class constructor

Parameters

Name	Type	Description
$options	array	(Optional) Options to set

compress(string $content) : string

Compresses the given content

Parameters

Name	Type	Description
$content	string

Returns

Type	Description
string

decompress(string $content) : boolean

Decompresses the given content

Parameters

Name	Type	Description
$content	string

Returns

Type	Description
boolean

getArchive() : string

Returns the set archive

Returns

Type	Description
string

getMode() : void

Returns the set compression mode

getOptions(string $option = null) : mixed

inherited

Returns one or all set options

Inherited from: \Zend_Filter_Compress_CompressAbstract::getOptions()

Parameters

Name	Type	Description
$option	string	(Optional) Option to return

Returns

Type	Description
mixed

getTarget() : string

Returns the set targetpath

Returns

Type	Description
string

setArchive(string $archive) : \Zend_Filter_Compress_Tar

Sets the archive to use for de-/compression

Parameters

Name	Type	Description
$archive	string	Archive to use

Returns

Type	Description
\Zend_Filter_Compress_Tar

setMode(string $mode) : void

Compression mode to use Eighter Gz or Bz2

Parameters

Name	Type	Description
$mode	string

setOptions(array $options) : \Zend_Filter_Compress_Bz2

inherited

Sets all or one option

Inherited from: \Zend_Filter_Compress_CompressAbstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Filter_Compress_Bz2

setTarget(string $target) : \Zend_Filter_Compress_Tar

Sets the targetpath to use

Parameters

Name	Type	Description
$target	string

Returns

Type	Description
\Zend_Filter_Compress_Tar

toString() : string

Returns the adapter name

Returns

Type	Description
string

Filter/Compress/Tar.php

\Zend_Filter_Compress_Tarjump to top

Properties

Methods

\Zend_Filter_Compress_Tar
jump to top