Archive_Tar::create()

Description

This method creates the archive file and adds the listed files or directories.

If a file with the same tar name exists and is writable, it is replaced by the new tar archive (it is not an 'add', but a 'create'). If a file exists and is write-protected or is a folder, the method raises a PEAR_Error.

Parameter

• mixed $filelist - an array of filenames and directory names, or a single string with names separated by a single blank space. For each directory added in the archive, the files and sub-directories are also added.

Return value

boolean - Returns TRUE on success, FALSE on failure.

Throws

Note

This function can not be called statically.

Example

$tar_object = new Archive_Tar("myArchive.tar");

// print errors
$tar_object->setErrorHandling(PEAR_ERROR_PRINT);  

// Archive content
$v_list[0]="file.txt";
// the slash is optional
$v_list[1]="data/"; 
$v_list[2]="file.log";

// create the archive
$tar_object->create($v_list);

$tar_object = new Archive_Tar("tarname.tgz", true);
$tar_object->setErrorHandling(PEAR_ERROR_PRINT);
$tar_object->create("file.txt data/ file.log");