string $_compress_type = 'none' (line 50)

• var: Type of compression : 'none', 'gz' or 'bz2'

string $_separator = ' ' (line 55)

• var: Explode separator

string $_temp_tarname = '' (line 65)

• var: Local Tar name of a remote Tar (http:// or ftp://)

add (line 196)

This method add the files / directories that are listed in $p_filelist in the archive. If the archive does not exist it is created.

The method return false and a PEAR error text. The files and directories listed are only added at the end of the archive, even if a file with the same name is already archived. See also createModify() method for more details.

• return: on success, false on error.
• access: public
• see: Archive_Tar::createModify()

• array $p_filelist: An array of filenames and directory names, or a single string with names separated by a single blank space.

addString (line 364)

This method add a single string as a file at the end of the existing archive. If the archive does not yet exists it is created.

• return: on success, false on error.
• access: public

• string $p_filename: A string which contains the full filename path that will be associated with the string.
• string $p_string: The content of the file added in the archive.

createModify (line 260)

This method creates the archive file and add the files / directories that are listed in $p_filelist.

If the file already exists and is writable, it is replaced by the new tar. It is a create and not an add. If the file exists and is read-only or is a directory it is not replaced. The method return false and a PEAR error text. The $p_filelist parameter can be an array of string, each string representing a filename or a directory name with their path if needed. It can also be a single string with names separated by a single blank. The path indicated in $p_remove_dir will be removed from the memorized path of each file / directory listed when this path exists. By default nothing is removed (empty path '') The path indicated in $p_add_dir will be added at the beginning of the memorized path of each file / directory listed. However it can be set to empty ''. The adding of a path is done after the removing of path. The path add/remove ability enables the user to prepare an archive for extraction in a different path than the origin files are. See also addModify() method for file adding properties.

• return: true on success, false on error.
• see: Archive_Tar::addModify()
• access: public

• array $p_filelist: An array of filenames and directory names, or a single string with names separated by a single blank space.
• string $p_add_dir: A string which contains a path to be added to the memorized path of each element in the list.
• string $p_remove_dir: A string which contains a path to be removed from the memorized path of each element in the list, when relevant.

extractInString (line 444)

This method extract from the archive one file identified by $p_filename.

The return value is a string with the file content, or NULL on error.

• return: string with the file content or NULL.
• access: public

• string $p_filename: The path of the file to extract in a string.

extractModify (line 422)

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.
• see: Archive_Tar::extractList()
• access: public

• 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.

setAttribute (line 506)

This method set specific attributes of the archive. It uses a variable

list of parameters, in the format attribute code + attribute values : $arch->setAttribute(ARCHIVE_TAR_ATT_SEPARATOR, ',');

• return: on success, false on error.
• access: public

• mixed $argv: variable list of attributes and values

_addList (line 792)

• $p_list
• $p_add_dir
• $p_remove_dir

_append (line 1553)

• $p_filelist
• $p_add_dir
• $p_remove_dir

_dirCheck (line 1577)

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

• return: TRUE if the directory exists or was created

• string $p_dir: directory to check

_extractList (line 1290)

• $p_path
• &$p_list_detail
• $p_mode
• $p_file_list
• $p_remove_path

_readBlock (line 735)

• $p_len

_readLongHeader (line 1213)

• &$v_header

_warning (line 559)

• $p_message

_writeHeaderBlock (line 1020)

• $p_filename
• $p_size
• $p_mtime
• $p_perms
• $p_type
• $p_uid
• $p_gid