Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JArchiveTar

Description
Description | Variables (details) | Methods (details)

Tar format adapter for the JArchive class

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>

  • since: 1.5

Located in /joomla/filesystem/archive/tar.php (line 31) 

Class JObject   (Subpackage Base)

Class JArchiveTar   (Subpackage FileSystem)
Variable Summary
Description | Variables (details) | Methods (details)
Variable string $_data
Variable array $_flags
Variable array $_metadata
Variable array $_types
Method Summary
Description | Variables (details) | Methods (details)
Method boolean extract (string $archive, string $destination, [array $options = array ()])
Variables
Description | Variables (details) | Methods (details)
string $_data = null (line 65)

Tar file data buffer

array $_flags = array (
'FTEXT' => 0x01,
'FHCRC' => 0x02,
'FEXTRA' => 0x04,
'FNAME' => 0x08,
'FCOMMENT' => 0x10
) (line 53)

Tar file flags.

array $_metadata = null (line 71)

Tar file metadata array

array $_types = array (
0x0 => 'Unix file',
0x30 => 'File',
0x31 => 'Link',
0x32 => 'Symbolic link',
0x33 => 'Character special file',
0x34 => 'Block special file',
0x35 => 'Directory',
0x36 => 'FIFO special file',
0x37 => 'Contiguous file'
) (line 37)

Tar file types.

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
extract (line 83)

Extract a ZIP compressed file to a given path

  • return: True if successful
  • since: 1.5
  • access: public
boolean extract (string $archive, string $destination, [array $options = array ()])
  • string $archive: Path to ZIP archive to extract
  • string $destination: Path to extract archive into
  • array $options: Extraction options [unused]

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
Documentation generated on Mon, 22 Sep 2008 12:15:14 +0100 by phpDocumentor 1.3.1