Archive_Tar
[ class tree: Archive_Tar ] [ index: Archive_Tar ] [ all elements ]

Class: Archive_Tar

Source Location: /Archive_Tar-1.3.11/Archive/Tar.php

Class Overview

PEAR
   |
   --Archive_Tar

Creates a (compressed) Tar archive


Author(s):

Version:

  • $Revision$

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 55]
Creates a (compressed) Tar archive


[ Top ]


Class Variables

$error_object = null

[line 95]

  • Var: object

Type:   object PEAR_Error


[ Top ]



Method Detail

Archive_Tar (Constructor)   [line 113]

Archive_Tar Archive_Tar( string $p_tarname, [string $p_compress = null])

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.

If the compress argument is set the tar will be read or created as a gzip or bz2 compressed TAR file.

  • Access: public

Parameters:

string   $p_tarname     The name of the tar archive to create
string   $p_compress     can be null, 'gz' or 'bz2'. This parameter indicates if gzip or bz2 compression is required. For compatibility reason the boolean value 'true' means 'gz'.

[ Top ]

_Archive_Tar (Destructor)   [line 179]

void _Archive_Tar( )


[ Top ]

add   [line 235]

true add( array $p_filelist)

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.


Parameters:

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

[ Top ]

addModify   [line 375]

true addModify( array $p_filelist, string $p_add_dir, [string $p_remove_dir = ''])

This method add the files / directories listed in $p_filelist at the end of the existing archive. If the archive does not yet exists it is created.

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. If a file/dir is already in the archive it will only be added at the end of the archive. There is no update of the existing archived file/dir. However while extracting the archive, the last file will replace the first one. This results in a none optimization of the archive size. If a file/dir does not exist the file/dir is ignored. However an error text is send to PEAR error. If a file/dir is not readable the file/dir is ignored. However an error text is send to PEAR error.

  • Return: on success, false on error.
  • Access: public

Parameters:

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.

[ Top ]

addString   [line 416]

true addString( string $p_filename, string $p_string, [int $p_datetime = false])

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

Parameters:

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.
int   $p_datetime     A custom date/time (unix timestamp) for the file (optional).

[ Top ]

create   [line 212]

true create( array $p_filelist)

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

If a file with the same name exist and is writable, it is replaced by the new tar. 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. For each directory added in the archive, the files and sub-directories are also added. See also createModify() method for more details.


Parameters:

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

[ Top ]

createModify   [line 302]

boolean createModify( array $p_filelist, string $p_add_dir, [string $p_remove_dir = ''])

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.


Parameters:

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.

[ Top ]

extract   [line 242]

void extract( [ $p_path = ''], [ $p_preserve = false])


Parameters:

   $p_path     
   $p_preserve     

[ Top ]

extractInString   [line 502]

a extractInString( string $p_filename)

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

Parameters:

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

[ Top ]

extractList   [line 537]

true extractList( array $p_filelist, [string $p_path = ''], [string $p_remove_path = ''], [boolean $p_preserve = false])

This method extract from the archive only the files indicated in the $p_filelist. These files are extracted in the current directory or in the directory indicated by the optional $p_path parameter.

If indicated the $p_remove_path can be used in the same way as it is used in extractModify() method.


Parameters:

array   $p_filelist     An array of filenames and directory names, or a single string with names separated by a single blank space.
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.
boolean   $p_preserve     Preserve user/group ownership of files

[ Top ]

extractModify   [line 477]

boolean extractModify( string $p_path, string $p_remove_path, [boolean $p_preserve = false])

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.


Parameters:

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.
boolean   $p_preserve     Preserve user/group ownership of files

[ Top ]

listContent   [line 249]

void listContent( )


[ Top ]

setAttribute   [line 572]

true setAttribute( mixed $argv)

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

Parameters:

mixed   $argv     variable list of attributes and values

[ Top ]

setIgnoreList   [line 643]

void setIgnoreList( array $list)

This method sets the regular expression for ignoring all files and directories matching the filenames in the array list at import, for example: $arch->setIgnoreList(array('CVS', '.svn', 'bin/tool'));
  • Access: public

Parameters:

array   $list     a list of file or directory names to ignore

[ Top ]

setIgnoreRegexp   [line 627]

void setIgnoreRegexp( string $regexp)

This method sets the regular expression for ignoring files and directories at import, for example: $arch->setIgnoreRegexp("#CVS|\.svn#");
  • Access: public

Parameters:

string   $regexp     regular expression defining which files or directories to ignore

[ Top ]


Documentation generated on Sat, 09 Feb 2013 12:00:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.