Class Horde_Compress_tar

Description

The Horde_Compress_tar class allows tar files to be read.

$Horde: framework/Compress/Compress/tar.php,v 1.4.12.13 2009/01/06 15:22:59 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Compress/Compress/tar.php (line 17)

Horde_Compress
   |
   --Horde_Compress_tar
Variable Summary
 array $_flags
 array $_types
Method Summary
 array decompress (string &$data, [array $params = array()])
Variables
array $_flags = array(
'FTEXT' => 0x01,
'FHCRC' => 0x02,
'FEXTRA' => 0x04,
'FNAME' => 0x08,
'FCOMMENT' => 0x10
)
(line 41)

Tar file flags.

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 24)

Tar file types.

Methods
decompress (line 66)

Decompress a tar file and get information from it.

  • return: The requested data or PEAR_Error on error.
     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
array decompress (string &$data, [array $params = array()])
  • string &$data: The tar file data.
  • array $params: The parameter array (Unused).

Redefinition of:
Horde_Compress::decompress()
Decompress the data.

Inherited Methods

Inherited From Horde_Compress

 Horde_Compress::Horde_Compress()
 Horde_Compress::compress()
 Horde_Compress::decompress()
 Horde_Compress::factory()
 Horde_Compress::singleton()

Documentation generated on Sun, 30 Jan 2011 05:22:38 +0000 by phpDocumentor 1.4.3