XOOPS Docs - kernel
[ class tree: kernel ] [ index: kernel ] [ all elements ]

Class: tar

Source Location: /class/class.tar.php

Class Overview


tar Class


Author(s):

Copyright:

  • Copyright (C) 2002 Josh Barger

Variables

Methods



Class Details

[line 93]
tar Class

This class reads and writes Tape-Archive (TAR) Files and Gzip compressed TAR files, which are mainly used on UNIX systems. This class works on both windows AND unix systems, and does NOT rely on external applications!! Woohoo!




Tags:

author:  Josh Barger <joshb@npt.com>
copyright:  Copyright (C) 2002 Josh Barger


[ Top ]


Class Variables

$directories =

[line 107]

Processed Archive Information


Type:   mixed


[ Top ]

$filename =

[line 98]

Unprocessed Archive Information


Type:   mixed


[ Top ]

$files =

[line 106]

Processed Archive Information


Type:   mixed


[ Top ]

$isGzipped =

[line 99]

Unprocessed Archive Information


Type:   mixed


[ Top ]

$numDirectories =

[line 109]

Processed Archive Information


Type:   mixed


[ Top ]

$numFiles =

[line 108]

Processed Archive Information


Type:   mixed


[ Top ]

$tar_file =

[line 100]

Unprocessed Archive Information


Type:   mixed


[ Top ]



Class Methods


constructor tar [line 116]

tar tar( )

Class Constructor -- Does nothing...



[ Top ]

method addDirectory [line 519]

bool addDirectory( string $dirname)

Add a directory to this tar archive



Parameters:

string   $dirname  

[ Top ]

method addFile [line 548]

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

Add a file to the tar archive



Parameters:

string   $filename  
boolean   $binary   Binary file?

[ Top ]

method appendTar [line 431]

bool appendTar( string $filename)

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



Parameters:

string   $filename  

[ Top ]

method containsDirectory [line 501]

bool containsDirectory( string $dirname)

Check if this tar archive contains a specific directory



Parameters:

string   $dirname  

[ Top ]

method containsFile [line 484]

bool containsFile( string $filename)

Check if this tar archive contains a specific file



Parameters:

string   $filename  

[ Top ]

method getDirectory [line 466]

string getDirectory( string $dirname)

Retrieves information about a directory in the current tar archive



Tags:

return:  FALSE on fail


Parameters:

string   $dirname  

[ Top ]

method getFile [line 448]

string getFile( string $filename)

Retrieves information about a file in the current tar archive



Tags:

return:  FALSE on fail


Parameters:

string   $filename  

[ Top ]

method openTAR [line 402]

bool openTAR( string $filename)

Open a TAR file



Parameters:

string   $filename  

[ Top ]

method removeDirectory [line 615]

bool removeDirectory( string $dirname)

Remove a directory from the tar archive



Parameters:

string   $dirname  

[ Top ]

method removeFile [line 595]

bool removeFile( string $filename)

Remove a file from the tar archive



Parameters:

string   $filename  

[ Top ]

method saveTar [line 634]

bool saveTar( )

Write the currently loaded tar archive to disk



[ Top ]

method toTar [line 653]

bool toTar( string $filename, bool $useGzip)

Saves tar archive to a different file than the current file



Parameters:

string   $filename  
bool   $useGzip   Use GZ compression?

[ Top ]

method toTarOutput [line 689]

string toTarOutput( string $filename, bool $useGzip)

Sends tar archive to stdout



Parameters:

string   $filename  
bool   $useGzip   Use GZ compression?

[ Top ]


XOOPS Docs generated by phpDocumentor