Tar Perl Reference Documentation

CkTar

Current Version: 11.5.0
Requires Chilkat Bundle License

Chilkat.Tar

Create, list, verify, filter, and extract TAR archives and compressed TAR formats.

Chilkat.Tar creates, verifies, lists, and extracts TAR archives, including compressed TAR formats such as .tar.gz, .tgz, .tar.bz2, and .tar.Z. It supports adding individual files and directory trees, controlling archive paths, preserving or overriding file permissions, filtering included or extracted files, extracting from memory, extracting selected entries to memory or BinData, producing XML listings, and creating Debian .deb package archives from control and data tarballs.

Create TAR archives

Add files or directory trees and write standard TAR output, with control over archive paths, directory handling, and write format.

Compressed TAR formats

Work with common compressed archive forms such as .tar.gz, .tgz, .tar.bz2, and .tar.Z.

List and verify contents

Inspect archive entries, verify archive structure, and produce XML listings for display, logging, or programmatic processing.

Selective extraction

Extract entire archives or selected entries, including workflows that extract matching files directly to memory or BinData.

Filters and paths

Include or exclude files using filters, control relative paths in the archive, and manage how entries are restored during extraction.

Permissions and packages

Preserve or override UNIX-style permissions and create Debian .deb package archives from control and data tarballs.

Common pattern: Use Tar when the data is a TAR archive or a compressed TAR archive. Configure the archive paths, filters, permissions, and compression format, then create, list, verify, or extract the archive as needed. Use Chilkat.Zip for ZIP archives, Chilkat.Gzip for a single GZIP stream, and Chilkat.Compression for raw compression operations.

For an extended overview, see Tar Class Overview.

Object Creation

$obj = chilkat::CkTar->new();

Properties

CaptureXmlListing
# $boolVal is a boolean
$boolVal = $tar->get_CaptureXmlListing();
$tar->put_CaptureXmlListing($boolVal);
Introduced in version 9.5.0.46

Controls whether extraction methods also capture an XML inventory of the archive. When set to 1, methods such as Untar, UntarGz, UntarBz2, and UntarZ store the listing in XmlListing. The XML has the same structure as the string returned by ListXml. The default is 0.

Inspect without extracting: Set CaptureXmlListing and SuppressOutput to 1 before an untar operation to scan the archive and obtain its XML listing without writing archive entries to disk.

top
Charset
# $strVal is a string
# $ckStr is a CkString
$tar->get_Charset($ckStr);
$strVal = $tar->charset();
$tar->put_Charset($strVal);

Specifies the character encoding used to decode filenames stored in a TAR archive during extraction. The default is utf-8, which is normally appropriate for modern archives.

This property affects archive entry names only. It does not convert or otherwise alter the contents of extracted files. TAR archives written by the WriteTar* methods store filenames as UTF-8.

Filename interoperability: The original TAR header format does not always identify the character encoding of a filename. Change this property only when an older archive is known to use a different encoding.

top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$tar->get_DebugLogFilePath($ckStr);
$strVal = $tar->debugLogFilePath();
$tar->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
DirMode
# $intVal is an integer
$intVal = $tar->get_DirMode();
$tar->put_DirMode($intVal);

Specifies the UNIX permission bits written to the TAR header for directory entries created by the WriteTar* methods. The default is octal 0755, which represents rwxr-xr-x.

Archive metadata: This value records permissions in the archive. Whether the exact permissions are restored during extraction depends on the destination operating system, filesystem, process privileges, and local security policy.

top
DirPrefix
# $strVal is a string
# $ckStr is a CkString
$tar->get_DirPrefix($ckStr);
$strVal = $tar->dirPrefix();
$tar->put_DirPrefix($strVal);

Specifies a path prefix to prepend to entries when a TAR archive is created. For example, setting this property to subdir1 causes an entry such as report.txt to be stored as subdir1/report.txt.

The prefix changes only the path stored in the archive; it does not rename or move the source file on disk.

AddFile2 exception: AddFile2 explicitly supplies the complete path within the archive, so DirPrefix is not applied to files added by that method.

top
FileMode
# $intVal is an integer
$intVal = $tar->get_FileMode();
$tar->put_FileMode($intVal);

Specifies the UNIX permission bits written to the TAR header for ordinary file entries created by the WriteTar* methods. The default is octal 0644, which represents rw-r--r--.

Shell scripts: Files recognized as shell scripts use ScriptFileMode instead, allowing executable permissions to be recorded separately.

top
GroupId
# $intVal is an integer
$intVal = $tar->get_GroupId();
$tar->put_GroupId($intVal);

Specifies the numeric group identifier (GID) written to TAR headers when an archive is created. The default value is 1000.

Ownership metadata: A stored GID is archive metadata. Restoring ownership may require elevated privileges and may be ignored or mapped differently on non-UNIX systems.

top
GroupName
# $strVal is a string
# $ckStr is a CkString
$tar->get_GroupName($ckStr);
$strVal = $tar->groupName();
$tar->put_GroupName($strVal);

Specifies the group name written to TAR headers when an archive is created. By default, Chilkat uses the username of the account running the application.

Name versus numeric ID: TAR headers can contain both a group name and the numeric GroupId. Extraction tools and operating systems may give different precedence to these fields.

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$tar->get_LastErrorHtml($ckStr);
$strVal = $tar->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$tar->get_LastErrorText($ckStr);
$strVal = $tar->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$tar->get_LastErrorXml($ckStr);
$strVal = $tar->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $tar->get_LastMethodSuccess();
$tar->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
MatchCaseSensitive
# $boolVal is a boolean
$boolVal = $tar->get_MatchCaseSensitive();
$tar->put_MatchCaseSensitive($boolVal);
Introduced in version 9.5.0.46

Controls whether the patterns in MustMatch and MustNotMatch are matched case-sensitively. The default is 0.

Cross-platform behavior: Case sensitivity in the archive filter is independent of whether the local filesystem itself treats filenames as case-sensitive.

top
MustMatch
# $strVal is a string
# $ckStr is a CkString
$tar->get_MustMatch($ckStr);
$strVal = $tar->mustMatch();
$tar->put_MustMatch($strVal);
Introduced in version 9.5.0.46

Specifies an inclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats. A candidate path is included or extracted only when it matches this pattern. The default is an empty string, which permits all paths.

The pattern may contain zero or more asterisks (*), where each asterisk matches zero or more characters. For example, *.txt selects paths ending in .txt. Case handling is controlled by MatchCaseSensitive.

Combined filters: If both MustMatch and MustNotMatch are set, a path must satisfy the inclusion pattern and must not satisfy the exclusion pattern.

top
MustNotMatch
# $strVal is a string
# $ckStr is a CkString
$tar->get_MustNotMatch($ckStr);
$strVal = $tar->mustNotMatch();
$tar->put_MustNotMatch($strVal);
Introduced in version 9.5.0.46

Specifies an exclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats. A candidate path that matches this pattern is skipped. The default is an empty string, which excludes nothing.

The pattern may contain zero or more asterisks (*), where each asterisk matches zero or more characters. For example, *.obj skips paths ending in .obj. Case handling is controlled by MatchCaseSensitive.

Exclusion takes effect after inclusion: When both filters are set, matching MustMatch does not override a match in MustNotMatch.

top
NoAbsolutePaths
# $boolVal is a boolean
$boolVal = $tar->get_NoAbsolutePaths();
$tar->put_NoAbsolutePaths($boolVal);

Controls whether absolute archive paths are converted to relative paths during extraction. When 1, a leading / or \ is removed before the entry is written. The default is 1.

Recommended security setting: Keep this property enabled when extracting archives you did not create. Also extract untrusted archives into a dedicated directory and inspect their entry names before relying on the extracted content.

top
NumDirRoots
# $intVal is an integer
$intVal = $tar->get_NumDirRoots();

Returns the number of directory roots currently registered for archive creation by calls to AddDirRoot and AddDirRoot2. Individual files added with AddFile or AddFile2 are not included in this count.

Use zero-based indexes from 0 through NumDirRoots - 1 with GetDirRoot.

top
ScriptFileMode
# $intVal is an integer
$intVal = $tar->get_ScriptFileMode();
$tar->put_ScriptFileMode($intVal);

Specifies the UNIX permission bits written to TAR headers for shell-script files recognized by extensions such as .sh, .csh, .bash, and .bsh. The default is octal 0755, which records executable permissions.

Other files: Non-script files use FileMode; directories use DirMode.

top
SuppressOutput
# $boolVal is a boolean
$boolVal = $tar->get_SuppressOutput();
$tar->put_SuppressOutput($boolVal);
Introduced in version 9.5.0.46

Controls whether untar operations write extracted files and directories to the filesystem. When 1, methods such as Untar, UntarGz, UntarBz2, and UntarZ scan the archive without producing extracted output. The default is 0.

Archive inventory workflow: Combine this property with CaptureXmlListing to obtain an XML listing without extracting the archive.

top
UntarCaseSensitive
# $boolVal is a boolean
$boolVal = $tar->get_UntarCaseSensitive();
$tar->put_UntarCaseSensitive($boolVal);

Deprecated. Use MatchCaseSensitive instead.

Until this property is removed, reading or setting it has the same effect as reading or setting MatchCaseSensitive.

top
UntarDebugLog
# $boolVal is a boolean
$boolVal = $tar->get_UntarDebugLog();
$tar->put_UntarDebugLog($boolVal);

Controls whether untar methods add per-entry extraction details to LastErrorText, LastErrorXml, and LastErrorHtml. The default is 0.

Diagnostic output is not necessarily an error: When this property is enabled, the LastError properties can contain useful extraction trace information even after a successful operation.

top
UntarDiscardPaths
# $boolVal is a boolean
$boolVal = $tar->get_UntarDiscardPaths();
$tar->put_UntarDiscardPaths($boolVal);

Controls whether directory components from archive entry names are discarded during extraction. When 1, each file is written directly into UntarFromDir rather than recreating the archived directory tree. The default is 0.

Filename collisions: Different archive entries can have the same final filename after their directory paths are removed. Use this option only when flattening the archive is intentional and potential collisions are acceptable.

top
UntarFromDir
# $strVal is a string
# $ckStr is a CkString
$tar->get_UntarFromDir($ckStr);
$strVal = $tar->untarFromDir();
$tar->put_UntarFromDir($strVal);

Specifies the destination directory for extraction. The default is ., meaning the current working directory of the calling process.

When UntarDiscardPaths is 0, archived subdirectories are recreated beneath this directory. When it is 1, extracted files are placed directly in this directory.

Safer extraction: For untrusted archives, choose a new or otherwise isolated destination directory rather than extracting directly into an application or system directory.

top
UntarMaxCount
# $intVal is an integer
$intVal = $tar->get_UntarMaxCount();
$tar->put_UntarMaxCount($intVal);

Limits the number of matching entries extracted by an untar operation. The default is 0, which means no maximum.

For example, set MustMatch to select a particular path and set UntarMaxCount to 1 to stop after the first matching entry is extracted.

Archive order matters: When a limit is used, extraction stops after the configured number of matches in archive order.

top
UserId
# $intVal is an integer
$intVal = $tar->get_UserId();
$tar->put_UserId($intVal);

Specifies the numeric user identifier (UID) written to TAR headers when an archive is created. The default value is 1000.

Ownership metadata: A stored UID does not by itself change the owner of a local source file. Restoring ownership during extraction may require elevated privileges and may not apply on non-UNIX systems.

top
UserName
# $strVal is a string
# $ckStr is a CkString
$tar->get_UserName($ckStr);
$strVal = $tar->userName();
$tar->put_UserName($strVal);

Specifies the user name written to TAR headers when an archive is created. By default, Chilkat uses the username of the account running the application.

Name versus numeric ID: TAR headers can contain both a user name and the numeric UserId. Their interpretation depends on the extracting tool and destination system.

top
Utf8
# $boolVal is a boolean
$boolVal = $tar->get_Utf8();
$tar->put_Utf8($boolVal);

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

More Information and Examples
Strings in Perl: Encoding, UTF-8, and Source File Format Considerations
top
VerboseLogging
# $boolVal is a boolean
$boolVal = $tar->get_VerboseLogging();
$tar->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$tar->get_Version($ckStr);
$strVal = $tar->version();

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top
WriteFormat
# $strVal is a string
# $ckStr is a CkString
$tar->get_WriteFormat($ckStr);
$strVal = $tar->writeFormat();
$tar->put_WriteFormat($strVal);

Specifies the TAR header format used by the WriteTar* methods. The default is gnu. Supported values are:

ValueUse
gnuGNU TAR format and extensions. This is the Chilkat default and supports archive metadata beyond classic ustar limits.
paxPOSIX pax extended format. It is designed to represent long names and additional metadata through extensible records.
ustarPOSIX ustar format. It is broadly interoperable but has stricter limits on path lengths and metadata fields.
Choosing a format: Use ustar when compatibility with simple TAR readers is the priority and the archive fits its limits. Use pax for portable extended metadata, or retain gnu when GNU TAR compatibility is expected.

top
XmlListing
# $strVal is a string
# $ckStr is a CkString
$tar->get_XmlListing($ckStr);
$strVal = $tar->xmlListing();
$tar->put_XmlListing($strVal);
Introduced in version 9.5.0.46

Contains the XML listing captured by the most recent untar operation for which CaptureXmlListing was 1. The XML structure is the same as the output from ListXml.

Read after the operation: Use the untar method's return value to confirm that the archive was processed successfully before consuming this property.

top

Methods

AddDirRoot
# $dirPath is a string
$status = $tar->AddDirRoot($dirPath);

Adds the directory tree at dirPath to the set of sources used by the next WriteTar* operation. Call this method multiple times to include multiple directory trees in one archive.

Use AddDirRoot2 when the tree should appear beneath an explicit prefix inside the archive.

Queued archive sources: Directory roots and files are retained by the object until ClearDirRootsAndFiles is called.

Returns 1 for success, 0 for failure.

top
AddDirRoot2
# $rootPrefix is a string
# $rootPath is a string
$status = $tar->AddDirRoot2($rootPrefix, $rootPath);
Introduced in version 9.5.0.56

Adds the directory tree at rootPath to the archive-creation source list and stores its entries beneath the archive prefix supplied in rootPrefix. Call this method multiple times, or combine it with AddDirRoot, before calling a WriteTar* method.

rootPrefix should be a relative archive path such as abc/123 and should not end with /. If DirPrefix is also set, DirPrefix is applied first.

Path composition example: With DirPrefix = "package" and rootPrefix = "assets", files from this root are stored beneath package/assets/.

Returns 1 for success, 0 for failure.

top
AddFile
# $path is a string
$status = $tar->AddFile($path);
Introduced in version 9.5.0.46

Adds the local file at path to the set of sources used by the next WriteTar* operation. Call AddFile, AddFile2, and the directory-root methods as needed before writing a single archive.

Use AddFile2 when the path stored inside the TAR must be specified independently of the source file path.

Queued archive sources: Added files and directory roots remain associated with the object until ClearDirRootsAndFiles is called.

Returns 1 for success, 0 for failure.

top
AddFile2
# $filePath is a string
# $pathWithinTar is a string
$status = $tar->AddFile2($filePath, $pathWithinTar);
Introduced in version 9.5.0.69

Adds the local file at filePath to the archive-creation source list and stores it using the exact archive path supplied in pathWithinTar. This allows the source path and the path visible inside the TAR to differ.

Call this method as many times as needed, optionally together with the other file and directory-root methods, before calling a single WriteTar* method.

DirPrefix is not applied: Because pathWithinTar already specifies the path within the TAR, DirPrefix does not modify entries added by this method. Use forward slashes and a relative path for portable archive names.

Returns 1 for success, 0 for failure.

top
ClearDirRootsAndFiles
$status = $tar->ClearDirRootsAndFiles();
Introduced in version 9.5.0.84

Removes all files and directory roots previously registered by AddDirRoot, AddDirRoot2, AddFile, and AddFile2.

Call this method before building a different archive with the same Tar object when the earlier source list should not be reused.

Returns 1 for success, 0 for failure.

top
CreateDeb
# $controlPath is a string
# $dataPath is a string
# $debPath is a string
$status = $tar->CreateDeb($controlPath, $dataPath, $debPath);
Introduced in version 9.5.0.66

Creates a Debian binary package at debPath from the prepared control archive at controlPath and data archive at dataPath. The inputs are typically named control.tar.gz and data.tar.gz, or use another compression form accepted by the target Debian tooling.

Debian package structure: A modern .deb file is an ar archive containing a debian-binary format marker, a control.tar.* member for package metadata and maintainer scripts, and a data.tar.* member for the installed filesystem payload.
Prepared inputs required: This method packages the supplied control and data tarballs. The caller is responsible for making their directory layout, control metadata, permissions, and package contents valid for Debian package-management tools.

Returns 1 for success, 0 for failure.

top
GetDirRoot
# $index is an integer
# $outStr is a CkString (output)
$status = $tar->GetDirRoot($index, $outStr);
$retStr = $tar->getDirRoot($index);

Returns a directory root previously added with AddDirRoot or AddDirRoot2. index is a zero-based index.

Valid indexes range from 0 through NumDirRoots - 1. For example, after two roots are added, GetDirRoot(0) returns the first and GetDirRoot(1) returns the second.

Returns 1 for success, 0 for failure.

top
ListXml
# $tarPath is a string
# $outStr is a CkString (output)
$status = $tar->ListXml($tarPath, $outStr);
$retStr = $tar->listXml($tarPath);

Scans the uncompressed TAR archive at tarPath and returns an XML description of its files, directories, and archive metadata. The archive is not extracted.

Compressed tarballs: For a compressed TAR archive, an untar method can capture the same listing format by setting CaptureXmlListing. Set SuppressOutput as well when no files should be written.

Returns 1 for success, 0 for failure.

top
ListXmlAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->ListXmlAsync($tarPath);

Creates an asynchronous task to call the ListXml method with the arguments provided.

Returns null on failure

top
LoadTaskCaller
# $task is a CkTask
$status = $tar->LoadTaskCaller($task);
Introduced in version 9.5.0.80

Loads the caller object associated with task, an asynchronous Chilkat Task, into this Tar object.

Specialized async support: This method supports Chilkat task-caller plumbing and is not normally needed in ordinary archive code. Use it only when a Chilkat example or support instruction specifically requires it.

Returns 1 for success, 0 for failure.

top
Untar
# $tarPath is a string
$retInt = $tar->Untar($tarPath);

Extracts the uncompressed TAR archive at tarPath into the directory specified by UntarFromDir. Archived directory trees are recreated unless UntarDiscardPaths is 1.

Returns the number of files and directories extracted, or -1 if the operation fails. Extraction is also affected by the matching, path-safety, count-limit, listing, and output-suppression properties of this object.

TAR is a container format: An ordinary .tar archive is not compressed. Use UntarGz, UntarBz2, or UntarZ for the corresponding compressed tarball formats.
More Information and Examples
Untar a .tar Archive
top
UntarAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->UntarAsync($tarPath);

Creates an asynchronous task to call the Untar method with the arguments provided.

Returns null on failure

top
UntarBz2
# $tarPath is a string
$status = $tar->UntarBz2($tarPath);

Decompresses and extracts the .tar.bz2 archive at tarPath into UntarFromDir. This format is also commonly named .tbz, .tbz2, or .tb2.

Returns 1 on success and 0 on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns 1 for success, 0 for failure.

More Information and Examples
Untar a .tar.bz2 Compressed Archive
top
UntarBz2Async (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->UntarBz2Async($tarPath);

Creates an asynchronous task to call the UntarBz2 method with the arguments provided.

Returns null on failure

top
UntarFirstMatchingToBd
# $tarPath is a string
# $matchPattern is a string
# $bd is a CkBinData
$status = $tar->UntarFirstMatchingToBd($tarPath, $matchPattern, $bd);
Introduced in version 9.5.0.82

Scans the uncompressed TAR archive at tarPath and copies the contents of the first file whose archive path matches matchPattern into the BinData object supplied in bd. Matching is evaluated in archive order.

No archive entry is written to the local filesystem. Returns 1 when a matching file is successfully extracted to bd and 0 otherwise.

Returns 1 for success, 0 for failure.

top
UntarGz
# $tarPath is a string
$status = $tar->UntarGz($tarPath);

Decompresses and extracts the .tar.gz archive at tarPath into UntarFromDir. The .tgz extension is a common short form for the same gzip-compressed TAR structure.

Returns 1 on success and 0 on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns 1 for success, 0 for failure.

More Information and Examples
Untar a .tar.gz (.tgz) Compressed Archive
top
UntarGzAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->UntarGzAsync($tarPath);

Creates an asynchronous task to call the UntarGz method with the arguments provided.

Returns null on failure

top
UntarZ
# $tarPath is a string
$status = $tar->UntarZ($tarPath);

Decompresses and extracts the .tar.Z archive at tarPath into UntarFromDir. The .Z suffix denotes the historical UNIX compress format; .taz is a common alternate extension.

Returns 1 on success and 0 on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns 1 for success, 0 for failure.

More Information and Examples
Untar a .tar.Z (.taz) Compressed Archive
top
UntarZAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->UntarZAsync($tarPath);

Creates an asynchronous task to call the UntarZ method with the arguments provided.

Returns null on failure

top
VerifyTar
# $tarPath is a string
$retBool = $tar->VerifyTar($tarPath);

Opens the uncompressed TAR archive at tarPath and scans its headers through the end of the archive. Returns 1 when the archive structure is accepted and no TAR-format errors are found; otherwise returns 0.

What verification does not establish: Structural verification does not prove that archived files are safe, trustworthy, or appropriate to extract. It is not malware scanning and does not authenticate the archive publisher.
top
VerifyTarAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->VerifyTarAsync($tarPath);

Creates an asynchronous task to call the VerifyTar method with the arguments provided.

Returns null on failure

top
WriteTar
# $tarPath is a string
$status = $tar->WriteTar($tarPath);

Creates an uncompressed TAR archive at tarPath from the files and directory trees previously added with AddFile, AddFile2, AddDirRoot, and AddDirRoot2. Archive paths, permissions, ownership metadata, filters, and header format are controlled by the corresponding properties.

Returns 1 on success and 0 on failure.

Returns 1 for success, 0 for failure.

More Information and Examples
Create TAR Archive
top
WriteTarAsync (1)
# returns a CkTask
# $tarPath is a string
$ret_task = $tar->WriteTarAsync($tarPath);

Creates an asynchronous task to call the WriteTar method with the arguments provided.

Returns null on failure

top
WriteTarBz2
# $bz2Path is a string
$status = $tar->WriteTarBz2($bz2Path);

Creates a bzip2-compressed TAR archive at bz2Path from the files and directory trees previously added to this object. Common filename extensions include .tar.bz2, .tbz, .tbz2, and .tb2.

Returns 1 on success and 0 on failure.

Two-layer format: The result is a TAR byte stream compressed with bzip2. TAR supplies the multi-file archive structure; bzip2 supplies compression.

Returns 1 for success, 0 for failure.

More Information and Examples
Create TAR BZ2 Compressed Archive (.tar.bz2, .tbz, .tbz2, .tb2)
top
WriteTarBz2Async (1)
# returns a CkTask
# $bz2Path is a string
$ret_task = $tar->WriteTarBz2Async($bz2Path);

Creates an asynchronous task to call the WriteTarBz2 method with the arguments provided.

Returns null on failure

top
WriteTarGz
# $gzPath is a string
$status = $tar->WriteTarGz($gzPath);

Creates a gzip-compressed TAR archive at gzPath from the files and directory trees previously added to this object. The usual extensions are .tar.gz and .tgz.

Returns 1 on success and 0 on failure.

Two-layer format: The result is a TAR byte stream compressed with gzip. TAR supplies the multi-file archive structure; gzip supplies compression.

Returns 1 for success, 0 for failure.

More Information and Examples
Create Compressed .tgz (.tar.gz) TAR Archive
top
WriteTarGzAsync (1)
# returns a CkTask
# $gzPath is a string
$ret_task = $tar->WriteTarGzAsync($gzPath);

Creates an asynchronous task to call the WriteTarGz method with the arguments provided.

Returns null on failure

top

Deprecated

UntarFirstMatchingToMemory Deprecated
# $tarFileBytes is a CkByteData
# $matchPattern is a string
# $outBytes is a CkByteData (output)
$status = $tar->UntarFirstMatchingToMemory($tarFileBytes, $matchPattern, $outData);

Reads an in-memory, uncompressed TAR archive from tarFileBytes and returns the contents of the first file whose archive path matches matchPattern. Matching is evaluated in archive order.

No file is written to the local filesystem. Use the normal method-success indicator and LastErrorText to distinguish a successful result from a missing match or processing failure.

Returns 1 for success, 0 for failure.

top
UntarFromMemory Deprecated
# $tarFileBytes is a CkByteData
$retInt = $tar->UntarFromMemory($tarFileBytes);

Extracts an uncompressed TAR archive supplied as bytes in tarFileBytes. Files and directories are written beneath UntarFromDir, subject to the same filters and path options as Untar.

Returns the number of files and directories extracted, or -1 on failure.

top
UntarFromMemoryAsync Deprecated (1)
# returns a CkTask
# $tarFileBytes is a CkByteData
$ret_task = $tar->UntarFromMemoryAsync($tarFileBytes);

Creates an asynchronous task to call the UntarFromMemory method with the arguments provided.

Returns null on failure

top