Docs For Class JArchiveTar

JArchiveTar

Description

Implements interfaces:

JArchiveExtractable

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: 11.1

Located in /libraries/joomla/archive/tar.php (line 29)

Method Summary

static boolean isSupported ()

boolean extract (string $archive, string $destination, [array $options = array()])

array _getTarInfo (string &$data)

Methods

static isSupported (line 141)

Tests whether this adapter can unpack files on this computer.

return: True if supported
since: 11.3
access: public

static boolean isSupported ()

Implementation of:

JArchiveExtractable::isSupported(): Tests whether this adapter can unpack files on this computer.

extract (line 76)

Extract a ZIP compressed file to a given path

return: True if successful
throws: RuntimeException
since: 11.1
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]

Implementation of:

JArchiveExtractable::extract(): Extract a compressed file to a given path

_getTarInfo (line 164)

Get the list of files/data from a Tar archive buffer.

return: Archive metadata array

 KEY: Position in the array
 VALUES: 'attr'  --  File attributes
 'data'  --  Raw file contents
 'date'  --  File modification time
 'name'  --  Filename
 'size'  --  Original file size
 'type'  --  File type

since: 11.1
access: protected

array _getTarInfo (string &$data)

string &$data: The Tar archive buffer.

Documentation generated on Tue, 19 Nov 2013 15:15:20 +0100 by phpDocumentor 1.4.3