Class Tar

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!

Package: kernel\core
Copyright: Copyright (C) 2002 Josh Barger
Author: Josh Barger joshb@npt.com
Located at lass/class.tar.php

Methods summary
`public`	# `__construct( )` Class Constructor -- Does nothing... Class Constructor -- Does nothing...
`public integer\|string`	# `__computeUnsignedChecksum( string $bytestring )` Computes the unsigned Checksum of a file's header to try to ensure valid file Computes the unsigned Checksum of a file's header to try to ensure valid file Parameters `$bytestring` Returns integer\|string
`public string`	# `__parseNullPaddedString( string $string )` Converts a NULL padded string to a non-NULL padded string Converts a NULL padded string to a non-NULL padded string Parameters `$string` Returns string
`public boolean`	# `__parseTar( )` This function parses the current TAR file This function parses the current TAR file Returns boolean always TRUE
`public boolean`	# `__readTar( string $filename = '' )` Read a non gzipped tar file in for processing. Read a non gzipped tar file in for processing. Parameters `$filename` full filename Returns boolean always TRUE
`public boolean`	# `__generateTar( )` Generates a TAR file from the processed data Generates a TAR file from the processed data Returns boolean always TRUE
`public boolean`	# `openTAR( string $filename )` Open a TAR file Open a TAR file Parameters `$filename` Returns boolean
`public boolean`	# `appendTar( string $filename )` Appends a tar file to the end of the currently opened tar file. Appends a tar file to the end of the currently opened tar file. Parameters `$filename` Returns boolean
`public string\|false`	# `getFile( string $filename )` Retrieves information about a file in the current tar archive Retrieves information about a file in the current tar archive Parameters `$filename` Returns string\|false FALSE on fail
`public string\|false`	# `getDirectory( string $dirname )` Retrieves information about a directory in the current tar archive Retrieves information about a directory in the current tar archive Parameters `$dirname` Returns string\|false FALSE on fail
`public boolean`	# `containsFile( string $filename )` Check if this tar archive contains a specific file Check if this tar archive contains a specific file Parameters `$filename` Returns boolean
`public boolean`	# `containsDirectory( string $dirname )` Check if this tar archive contains a specific directory Check if this tar archive contains a specific directory Parameters `$dirname` Returns boolean
`public boolean`	# `addDirectory( string $dirname )` Add a directory to this tar archive Add a directory to this tar archive Parameters `$dirname` Returns boolean
`public boolean`	# `addFile( string $filename, boolean $binary = false )` Add a file to the tar archive Add a file to the tar archive Parameters `$filename` `$binary` Binary file? Returns boolean
`public boolean`	# `removeFile( string $filename )` Remove a file from the tar archive Remove a file from the tar archive Parameters `$filename` Returns boolean
`public boolean`	# `removeDirectory( string $dirname )` Remove a directory from the tar archive Remove a directory from the tar archive Parameters `$dirname` Returns boolean
`public boolean`	# `saveTar( )` Write the currently loaded tar archive to disk Write the currently loaded tar archive to disk Returns boolean
`public boolean`	# `toTar( string $filename, boolean $useGzip )` Saves tar archive to a different file than the current file Saves tar archive to a different file than the current file Parameters `$filename` `$useGzip` Use GZ compression? Returns boolean
`public string`	# `toTarOutput( string $filename, boolean $useGzip )` Sends tar archive to stdout Sends tar archive to stdout Parameters `$filename` `$useGzip` Use GZ compression? Returns string

Properties summary
`public`	`$filename` #@+ Unprocessed Archive Information #@+ Unprocessed Archive Information	#
`public`	`$isGzipped`	#
`public`	`$tar_file`	#
`public`	`$files` #@+ Processed Archive Information #@+ Processed Archive Information	#
`public`	`$directories`	#
`public`	`$numFiles`	#
`public`	`$numDirectories`	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class Tar

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns