Docs For Class tar

Description

Located in /system/tar.php (line 2)

Variable Summary

mixed $directories

mixed $filename

mixed $files

mixed $isGzipped

mixed $numDirectories

mixed $numFiles

mixed $tar_file

Method Summary

tar tar ()

bool addDirectory (string $dirname, [mixed $recurse = false])

bool addFile (string $filename, [boolean $binary = false])

bool appendTar (string $filename)

bool containsDirectory (string $dirname)

bool containsFile (string $filename)

string getDirectory (string $dirname)

string getFile (string $filename)

bool openTAR (string $filename)

bool removeDirectory (string $dirname)

bool removeFile (string $filename)

bool saveTar ()

bool toTar (string $filename, bool $useGzip)

string toTarOutput (string $filename, bool $useGzip)

Variables

mixed $directories (line 8)

mixed $filename (line 3)

mixed $files (line 7)

mixed $isGzipped (line 4)

mixed $numDirectories (line 10)

mixed $numFiles (line 9)

mixed $tar_file (line 5)

Methods

Constructor tar (line 12)

tar tar ()

addDirectory (line 409)

Add a directory to this tar archive

bool addDirectory (string $dirname, [mixed $recurse = false])

string $dirname

addFile (line 452)

Add a file to the tar archive

bool addFile (string $filename, [boolean $binary = false])

string $filename
boolean $binary: Binary file?

appendTar (line 321)

Appends a tar file to the end of the currently opened tar file.

bool appendTar (string $filename)

string $filename

containsDirectory (line 391)

Check if this tar archive contains a specific directory

bool containsDirectory (string $dirname)

string $dirname

containsFile (line 374)

Check if this tar archive contains a specific file

bool containsFile (string $filename)

string $filename

getDirectory (line 356)

Retrieves information about a directory in the current tar archive

return: FALSE on fail

string getDirectory (string $dirname)

string $dirname

getFile (line 338)

Retrieves information about a file in the current tar archive

return: FALSE on fail

string getFile (string $filename)

string $filename

openTAR (line 292)

Open a TAR file

bool openTAR (string $filename)

string $filename

removeDirectory (line 520)

Remove a directory from the tar archive

bool removeDirectory (string $dirname)

string $dirname

removeFile (line 500)

Remove a file from the tar archive

bool removeFile (string $filename)

string $filename

saveTar (line 539)

Write the currently loaded tar archive to disk

bool saveTar ()

toTar (line 558)

Saves tar archive to a different file than the current file

bool toTar (string $filename, bool $useGzip)

string $filename
bool $useGzip: Use GZ compression?

toTarOutput (line 592)

Sends tar archive to stdout

string toTarOutput (string $filename, bool $useGzip)

string $filename
bool $useGzip: Use GZ compression?