## Class TTarFileExtractor

Description

TTarFileExtractor class

- since: 3.0
- version: $Id: TTarFileExtractor.php 1637 2007-01-17 22:26:53Z xue $
- author: Vincent Blavet <vincent@phpconcept.net>

Located in /IO/TTarFileExtractor.php (line 38)

Method Summary
TTarFileExtractor __construct (string $p_tarname)
void __destruct ()
void extract ([mixed $p_path = ''])
boolean extractModify (string $p_path, string $p_remove_path)
bool _dirCheck (string $p_dir)
void _error (mixed $p_message)
void _extractList (mixed $p_path, mixed &$p_list_detail, mixed $p_mode, mixed $p_file_list, mixed $p_remove_path)
void _translateWinPath (mixed $p_path, [mixed $p_remove_disk_letter = true])
Methods
Constructor __construct (line 63)

Archive_Tar Class constructor. This flavour of the constructor only declare a new Archive_Tar object, identifying it by the name of the tar file.

- access: public

TTarFileExtractor __construct (string $p_tarname)

- string $p_tarname: The name of the tar archive to create

Destructor __destruct (line 68)

- access: public

void __destruct ()
extract (line 76)

- access: public

void extract ([mixed $p_path = ''])
extractModify (line 113)

This method extract all the content of the archive in the directory indicated by $p_path. When relevant the memorized path of the files/dir can be modified by removing the $p_remove_path path at the beginning of the file/dir path.

While extracting a file, if the directory path does not exists it is created. While extracting a file, if the file already exists it is replaced without looking for last modification date. While extracting a file, if the file already exists and is write protected, the extraction is aborted. While extracting a file, if a directory with the same name already exists, the extraction is aborted. While extracting a directory, if a file with the same name already exists, the extraction is aborted. While extracting a file/directory if the destination directory exist and is write protected, or does not exist but can not be created, the extraction is aborted. If after extraction an extracted file does not show the correct stored file size, the extraction is aborted. When the extraction is aborted, a PEAR error text is set and false is returned. However the result can be a partial extraction that may need to be manually cleaned.

- return: true on success, false on error.
- access: protected

boolean extractModify (string $p_path, string $p_remove_path)

- string $p_path: The path of the directory where the files/dir need to by extracted.
- string $p_remove_path: Part of the memorized path that can be removed if present at the beginning of the file/dir path.

_dirCheck (line 537)

Check if a directory exists and create it (including parent dirs) if not.

- return: true if the directory exists or was created
- access: protected

bool _dirCheck (string $p_dir)

- string $p_dir: directory to check

_error (line 127)

- access: protected

void _error (mixed $p_message)
_extractList (line 322)

- access: protected

void _extractList (mixed $p_path, mixed &$p_list_detail, mixed $p_mode, mixed $p_file_list, mixed $p_remove_path)
_translateWinPath (line 558)

- access: protected

void _translateWinPath (mixed $p_path, [mixed $p_remove_disk_letter = true])

Documentation generated on Sun, 11 Jan 2009 20:24:08 -0500 by phpDocumentor 1.3.0RC4