Library Group: format

Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.

| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| addDirTree() | function | Adds one directory tree to an open ZIP archive under a given root path. | void |
| addFile() | function | Adds or replaces a single file in an existing ZIP archive. | void |
| addPath() | function | Adds or replaces one file or directory in an existing ZIP archive. | void |
| addPathToArchive() | function | Adds one file or directory path to an open ZIP archive. | void |
| assertAvailable() | function | Throws when the PHP zip extension is unavailable. | void |
| compressDir() | function | Creates a ZIP archive from all files in a source directory. | void |
| compressPath() | function | Creates a ZIP archive from one source file or directory. | void |
| extractDir() | function | Extracts one named ZIP directory into a target directory. | void |
| extractFile() | function | Extracts a single named entry from a ZIP archive to a target file path. | void |
| extractTo() | function | Extracts all entries from a ZIP archive into a target directory. | void |
| isSafeEntryPath() | function | Returns true when a ZIP entry path is safe to extract. | bool True when the path is safe for extraction. |
| isSymlinkEntry() | function | Returns whether a ZIP member carries Unix symbolic-link metadata. | bool True when the member is marked as a Unix symbolic link. |
| listEntries() | function | Returns all entry names in a ZIP archive as an indexed array. | array<int, string> List of entry names. |
| manifestEntryIndexes() | function | Collects candidate manifest entry indexes in preferred lookup order. | array<int, int> List of entry indexes in preferred order. |
| manifestSlug() | function | Reads a slug value from a manifest JSON file inside a ZIP archive. | string\|null The slug string, or null if none found or valid. |
| normalizeDirEntry() | function | Normalizes one archive directory prefix and guarantees a trailing slash. | string Safe normalized directory prefix ending in /. |
| normalizeEntryName() | function | Normalizes one archive-internal entry path and rejects traversal. | string Safe normalized entry path. |
| open() | function | Opens a ZIP archive for reading, throwing on failure. | ZipArchive Opened archive handle. |
| Raven\Lib\Format\Bz2::compress() | method | Compresses a file to a .bz2 file using bzip2. | void |
| Raven\Lib\Format\Bz2::decompress() | method | Decompresses a .bz2 file to a plain file. | void |
| Raven\Lib\Format\Bz2::isAvailable() | method | Returns true when the PHP bz2 extension is loaded and available. | bool True when bzip2 support is present. |
| Raven\Lib\Format\Csv::read() | method | Yields rows from a CSV file as indexed or associative arrays. | Generator<int, array<int\|string, string>> Rows yielded one at a time. |
| Raven\Lib\Format\Csv::readStream() | method | Yields rows from an already-open stream as indexed or associative arrays. | Generator<int, array<int\|string, string>> Rows yielded one at a time. |
| Raven\Lib\Format\Csv::streamToOutput() | method | Streams rows directly to the current PHP output buffer as a CSV download. | void |
| Raven\Lib\Format\Csv::uploadErrorMessage() | method | Returns a human-readable error message for a PHP upload error code. | string Error message safe for display. |
| Raven\Lib\Format\Csv::write() | method | Writes rows to a CSV file, optionally prepending a header row. | void |
| Raven\Lib\Format\Csv::writeStream() | method | Writes rows to an already-open stream, optionally prepending a header row. | void |
| Raven\Lib\Format\Git::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Git::addRemote() | method | Adds a named remote to an existing local repository. | void |
| Raven\Lib\Format\Git::currentBranch() | method | Returns the current branch name in a local repository. | string Current branch name, or detached. |
| Raven\Lib\Format\Git::currentRevision() | method | Returns the full commit SHA of the current HEAD in a local repository. | string Full 40-character commit SHA. |
| Raven\Lib\Format\Git::extractTree() | method | Extracts the checked-out work tree of a repository into a target directory. | void |
| Raven\Lib\Format\Git::fetch() | method | Fetches refs from a remote into an existing local repository. | void |
| Raven\Lib\Format\Git::init() | method | Initializes a new empty repository in the given directory. | void |
| Raven\Lib\Format\Git::isAvailable() | method | Returns true when the git binary is reachable and executable. | bool True when git is available on this system. |
| Raven\Lib\Format\Git::isRepository() | method | Returns true when the given directory is inside a git working tree. | bool True when the directory is inside a repository. |
| Raven\Lib\Format\Git::mustRun() | method | Runs one git command and throws when the exit code is non-zero. | array{ |
| Raven\Lib\Format\Git::run() | method | Runs one git command without shell interpolation. | array{ |
| Raven\Lib\Format\Git::string() | method | Clones a remote Git repository into a local target directory. | void |
| Raven\Lib\Format\Gz::compress() | method | Compresses a file to a .gz file using gzip. | void |
| Raven\Lib\Format\Gz::decompress() | method | Decompresses a .gz file to a plain file. | void |
| Raven\Lib\Format\Json::decode() | method | Decodes one JSON string to an associative array. | array<int\|string, mixed>\|null Decoded associative payload, or null on invalid/missing data. |
| Raven\Lib\Format\Json::decodeFile() | method | Reads and decodes one JSON file to an associative array. | array<int\|string, mixed>\|null Decoded payload, or null on read/decode failure. |
| Raven\Lib\Format\Json::encode() | method | Encodes one value to JSON. | string\|null Encoded JSON, or null on encode failure. |
| Raven\Lib\Format\Json::writeFile() | method | Atomically writes one JSON payload to disk. | bool True when the write succeeds. |
| Raven\Lib\Format\Szip::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Szip::addPath() | method | Adds or replaces one file or directory inside an existing .7z archive. | void |
| Raven\Lib\Format\Szip::compressPath() | method | Creates one .7z archive from a source file or directory. | void |
| Raven\Lib\Format\Szip::extractDir() | method | Extracts one named archive directory into a target directory. | void |
| Raven\Lib\Format\Szip::extractFile() | method | Extracts one named archive entry to a target file path. | void |
| Raven\Lib\Format\Szip::extractTo() | method | Extracts one full .7z archive into a target directory. | void |
| Raven\Lib\Format\Szip::isAvailable() | method | Returns true when the 7z binary is reachable and executable. | bool True when 7-Zip can be used on this system. |
| Raven\Lib\Format\Szip::isSafeEntryPath() | method | Returns true when one archive-internal path is safe to extract. | bool True when the path is extraction-safe. |
| Raven\Lib\Format\Szip::listEntries() | method | Returns all entry names stored in a .7z archive. | array<int, string> Normalized archive-internal entry names. |
| Raven\Lib\Format\Szip::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Szip::void() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::addPath() | method | Adds or replaces one file or directory in an existing .tar archive. | void |
| Raven\Lib\Format\Tar::compressDir() | method | Creates a .tar archive from all files in a source directory. | void |
| Raven\Lib\Format\Tar::compressDirBz2() | method | Creates a .tar.bz2 archive from all files in a source directory. | void |
| Raven\Lib\Format\Tar::compressDirGz() | method | Creates a .tar.gz archive from all files in a source directory. | void |
| Raven\Lib\Format\Tar::compressDirXz() | method | Creates a .tar.xz archive from all files in a source directory. | void |
| Raven\Lib\Format\Tar::compressDirZst() | method | Creates a .tar.zst archive from all files in a source directory. | void |
| Raven\Lib\Format\Tar::compressPath() | method | Creates a .tar archive from one source file or directory. | void |
| Raven\Lib\Format\Tar::compressPathBz2() | method | Creates a .tar.bz2 archive from one source file or directory. | void |
| Raven\Lib\Format\Tar::compressPathGz() | method | Creates a .tar.gz archive from one source file or directory. | void |
| Raven\Lib\Format\Tar::compressPathXz() | method | Creates a .tar.xz archive from one source file or directory. | void |
| Raven\Lib\Format\Tar::compressPathZst() | method | Creates a .tar.zst archive from one source file or directory. | void |
| Raven\Lib\Format\Tar::extractDir() | method | Extracts one named TAR directory into a target directory. | void |
| Raven\Lib\Format\Tar::extractFile() | method | Extracts a single named entry from a TAR (or .tar.gz) archive. | void |
| Raven\Lib\Format\Tar::extractTo() | method | Extracts all entries from a TAR (or .tar.gz) archive into a directory. | void |
| Raven\Lib\Format\Tar::int() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::listEntries() | method | Returns all entry names in a TAR (or .tar.gz) archive as an indexed array. | array<int, string> List of entry names. |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Tar::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Txt::read() | method | Reads one text file from disk. | string File contents. |
| Raven\Lib\Format\Txt::write() | method | Writes one text file atomically with an optional chmod. | void |
| Raven\Lib\Format\Xz::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Xz::compress() | method | Compresses a file to a .xz file. | void |
| Raven\Lib\Format\Xz::decompress() | method | Decompresses a .xz file to a plain file. | void |
| Raven\Lib\Format\Xz::isAvailable() | method | Returns true when the xz binary is reachable and executable. | bool True when xz is available on this system. |
| Raven\Lib\Format\Zip::isAvailable() | method | Returns true when the PHP zip extension is loaded and usable. | bool True when ZipArchive is available. |
| Raven\Lib\Format\Zst::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Format\Zst::compress() | method | Compresses a file to a .zst file using Zstandard. | void |
| Raven\Lib\Format\Zst::decompress() | method | Decompresses a .zst file to a plain file. | void |
| Raven\Lib\Format\Zst::isAvailable() | method | Returns true when the zstd binary is reachable and executable. | bool True when zstd is available on this system. |
| writeExtractedEntry() | function | Writes one extracted archive entry to disk. | void |

Parameter Details

addDirTree()

• File: private/lib/Format/Zip.php
• Params:
• ZipArchive $zip Open ZIP archive handle.
• string $sourceDir Absolute path to the source directory.
• string $entryRoot ZIP-internal directory root.

addFile()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the ZIP file to modify or create.
• string $sourcePath Absolute path to the file to add.
• string $entryName ZIP-internal entry name for the file.

addPath()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the ZIP archive to modify or create.
• string $sourcePath Absolute path to the file or directory to add.
• string $entryName ZIP-internal destination path.

addPathToArchive()

• File: private/lib/Format/Zip.php
• Params:
• ZipArchive $zip Open ZIP archive handle.
• string $sourcePath Absolute path to the file or directory to add.
• string $entryName ZIP-internal destination path.

assertAvailable()

• File: private/lib/Format/Zip.php
• Params: (none)

compressDir()

• File: private/lib/Format/Zip.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $archiveRoot Optional directory name to use as the archive root prefix.
• string $outputPath Absolute path where the ZIP file should be created.

compressPath()

• File: private/lib/Format/Zip.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $entryName Preferred archive-internal root name.
• string $outputPath Absolute path where the ZIP file should be created.

extractDir()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the source ZIP file.
• string $entryName ZIP-internal directory path to extract.
• string $targetDir Absolute path that should receive the directory contents.

extractFile()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the source ZIP file.
• string $entryName ZIP-internal entry name to extract.
• string $targetPath Absolute path where the extracted file should land.

extractTo()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the source ZIP file.
• string $targetDir Absolute path to the destination directory.

isSafeEntryPath()

• File: private/lib/Format/Zip.php
• Params:
• string $entryName Raw entry name from the ZIP directory.

isSymlinkEntry()

• File: private/lib/Format/Zip.php
• Params:
• ZipArchive $zip Open ZIP archive handle.
• int $index Zero-based member index.

listEntries()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the ZIP file.

manifestEntryIndexes()

• File: private/lib/Format/Zip.php
• Params:
• ZipArchive $zip Open ZIP archive handle.
• string $manifestFile Lowercase manifest filename to search for.

manifestSlug()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the ZIP file.
• string $manifestFilename Manifest file basename to search for (e.g. \ext.json\).
• int $maxSlugLength Maximum allowed slug length for the regex check.

normalizeDirEntry()

• File: private/lib/Format/Zip.php
• Params:
• string $entryName Archive-internal directory path candidate.

normalizeEntryName()

• File: private/lib/Format/Zip.php
• Params:
• string $entryName Archive-internal path candidate.

open()

• File: private/lib/Format/Zip.php
• Params:
• string $archivePath Absolute path to the ZIP file.

Raven\Lib\Format\Bz2::compress()

• File: private/lib/Format/Bz2.php
• Params:
• string $sourcePath Absolute path to the uncompressed source file.
• string $targetPath Absolute path where the .bz2 output should land.
• int $blockSize Block size 1–9 (1 = fastest/least compressed, 9 = most); default 9.

Raven\Lib\Format\Bz2::decompress()

• File: private/lib/Format/Bz2.php
• Params:
• string $sourcePath Absolute path to the .bz2 compressed file.
• string $targetPath Absolute path where the decompressed output should land.

Raven\Lib\Format\Bz2::isAvailable()

• File: private/lib/Format/Bz2.php
• Params: (none)

Raven\Lib\Format\Csv::read()

• File: private/lib/Format/Csv.php
• Params:
• string $filePath Absolute path to the .csv file.
• bool $hasHeader Whether the first row contains column names.
• string $separator Field separator character; defaults to \,\.

Raven\Lib\Format\Csv::readStream()

• File: private/lib/Format/Csv.php
• Params:
• resource $stream Open file-stream resource positioned at the start.
• bool $hasHeader Whether the first row contains column names.
• string $separator Field separator character; defaults to \,\.

Raven\Lib\Format\Csv::streamToOutput()

• File: private/lib/Format/Csv.php
• Params:
• string $filename Suggested download filename (e.g. \export.csv\).
• iterable<mixed> $rows Rows to stream.
• array<int,string>|null $header Optional header row.
• string $separator Field separator character; defaults to \,\.

Raven\Lib\Format\Csv::uploadErrorMessage()

• File: private/lib/Format/Csv.php
• Params:
• int $code One of the \UPLOADERR*\ constants.
• string $fileLabel Human-readable label for the file being uploaded (e.g. \CSV\).

Raven\Lib\Format\Csv::write()

• File: private/lib/Format/Csv.php
• Params:
• string $filePath Absolute path to the output .csv file.
• iterable<mixed> $rows Rows to write; each row must be an array of scalars.
• array<int,string>|null $header Optional header row written before data rows.
• string $separator Field separator character; defaults to \,\.
• bool $writeBom Prepend a UTF-8 BOM; useful for Excel downloads.

Raven\Lib\Format\Csv::writeStream()

• File: private/lib/Format/Csv.php
• Params:
• resource $stream Open writable stream resource.
• iterable<mixed> $rows Rows to write; each row must be an array of scalars.
• array<int,string>|null $header Optional header row.
• string $separator Field separator character; defaults to \,\.
• bool $writeBom Prepend a UTF-8 BOM.

Raven\Lib\Format\Git::__construct()

• File: private/lib/Format/Git.php
• Params:
• string $binary Git binary path; defaults to \git\.

Raven\Lib\Format\Git::addRemote()

• File: private/lib/Format/Git.php
• Params:
• string $repoDir Working directory of the local repository.
• string $name Remote name to add.
• string $url Remote URL.

Raven\Lib\Format\Git::currentBranch()

• File: private/lib/Format/Git.php
• Params:
• string $repoDir Working directory of the local repository.

Raven\Lib\Format\Git::currentRevision()

• File: private/lib/Format/Git.php
• Params:
• string $repoDir Working directory of the local repository.

Raven\Lib\Format\Git::extractTree()

• File: private/lib/Format/Git.php
• Params:
• string $repoDir Working directory of the source repository.
• string $targetDir Absolute destination directory.

Raven\Lib\Format\Git::fetch()

• File: private/lib/Format/Git.php
• Params:
• string $repoDir Working directory of the local repository.
• string $remote Remote name or URL.
• string|null $ref Optional branch or refspec.
• int $depth Optional shallow fetch depth; \0\ means full history.

Raven\Lib\Format\Git::init()

• File: private/lib/Format/Git.php
• Params:
• string $dir Absolute path for the new repository directory.

Raven\Lib\Format\Git::isAvailable()

• File: private/lib/Format/Git.php
• Params: (none)

Raven\Lib\Format\Git::isRepository()

• File: private/lib/Format/Git.php
• Params:
• string $dir Absolute path to inspect.

Raven\Lib\Format\Git::mustRun()

• File: private/lib/Format/Git.php
• Params:
• array<int, string> $arguments Git CLI arguments excluding the binary.
• string|null $cwd Optional working directory.
• string|null $stdin Optional stdin payload.

Raven\Lib\Format\Git::run()

• File: private/lib/Format/Git.php
• Params:
• array<int, string> $arguments Git CLI arguments excluding the binary.
• string|null $cwd Optional working directory.
• string|null $stdin Optional stdin payload.

Raven\Lib\Format\Git::string()

• File: private/lib/Format/Git.php
• Params:
• string $url Remote repository URL.
• string $targetDir Absolute clone target directory.
• string|null $branch Optional branch to clone.
• int $depth Shallow clone depth; \0\ means full clone.

Raven\Lib\Format\Gz::compress()

• File: private/lib/Format/Gz.php
• Params:
• string $sourcePath Absolute path to the uncompressed source file.
• string $targetPath Absolute path where the .gz output file should land.
• int $level Compression level 1 (fast) to 9 (best); default 6.

Raven\Lib\Format\Gz::decompress()

• File: private/lib/Format/Gz.php
• Params:
• string $sourcePath Absolute path to the .gz compressed file.
• string $targetPath Absolute path where the decompressed output should land.

Raven\Lib\Format\Json::decode()

• File: private/lib/Format/Json.php
• Params:
• string $json Raw JSON string.
• int $maxDepth Maximum decode depth.

Raven\Lib\Format\Json::decodeFile()

• File: private/lib/Format/Json.php
• Params:
• string $path Absolute or relative JSON file path.
• int $maxBytes Maximum bytes to read.
• int $maxDepth Maximum decode depth.

Raven\Lib\Format\Json::encode()

• File: private/lib/Format/Json.php
• Params:
• mixed $value Value to encode.
• int $flags Json-encode flags (without JSON_THROW_ON_ERROR).

Raven\Lib\Format\Json::writeFile()

• File: private/lib/Format/Json.php
• Params:
• string $path Target file path.
• mixed $value Value to JSON-encode and write.
• int $flags Json-encode flags (without JSON_THROW_ON_ERROR).

Raven\Lib\Format\Szip::__construct()

• File: private/lib/Format/Szip.php
• Params:
• string $binary Path to the 7-Zip binary; defaults to \7z\.

Raven\Lib\Format\Szip::addPath()

• File: private/lib/Format/Szip.php
• Params:
• string $archivePath Absolute path to the target archive.
• string $sourcePath Absolute path to the file or directory to add.
• string|null $entryName Optional archive-internal destination path.

Raven\Lib\Format\Szip::compressPath()

• File: private/lib/Format/Szip.php
• Params:
• string $sourcePath Absolute path to the file or directory to archive.
• string $outputPath Absolute output \.7z\ path.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Szip::extractDir()

• File: private/lib/Format/Szip.php
• Params:
• string $archivePath Absolute path to the source archive.
• string $entryName Archive-internal directory path to extract.
• string $targetDir Absolute directory that should receive the directory contents.

Raven\Lib\Format\Szip::extractFile()

• File: private/lib/Format/Szip.php
• Params:
• string $archivePath Absolute path to the source archive.
• string $entryName Archive-internal file path to extract.
• string $targetPath Absolute output path for the extracted file.

Raven\Lib\Format\Szip::extractTo()

• File: private/lib/Format/Szip.php
• Params:
• string $archivePath Absolute path to the source archive.
• string $targetDir Absolute path to the extraction directory.

Raven\Lib\Format\Szip::isAvailable()

• File: private/lib/Format/Szip.php
• Params: (none)

Raven\Lib\Format\Szip::isSafeEntryPath()

• File: private/lib/Format/Szip.php
• Params:
• string $entryName Archive-internal path candidate.

Raven\Lib\Format\Szip::listEntries()

• File: private/lib/Format/Szip.php
• Params:
• string $archivePath Absolute path to the source archive.

Raven\Lib\Format\Szip::string()

• File: private/lib/Format/Szip.php
• Params: (none)

Raven\Lib\Format\Szip::void()

• File: private/lib/Format/Szip.php
• Params: (none)

Raven\Lib\Format\Tar::__construct()

• File: private/lib/Format/Tar.php
• Params:
• string $binary Path to the tar binary; defaults to \tar\.

Raven\Lib\Format\Tar::addPath()

• File: private/lib/Format/Tar.php
• Params:
• string $archivePath Absolute path to the target \.tar\ archive.
• string $sourcePath Absolute path to the file or directory to add.
• string|null $entryName Optional archive-internal destination path.

Raven\Lib\Format\Tar::compressDir()

• File: private/lib/Format/Tar.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $outputPath Absolute path where the .tar file should be written.

Raven\Lib\Format\Tar::compressDirBz2()

• File: private/lib/Format/Tar.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $outputPath Absolute path where the .tar.bz2 file should be written.

Raven\Lib\Format\Tar::compressDirGz()

• File: private/lib/Format/Tar.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $outputPath Absolute path where the .tar.gz file should be written.

Raven\Lib\Format\Tar::compressDirXz()

• File: private/lib/Format/Tar.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $outputPath Absolute path where the .tar.xz file should be written.

Raven\Lib\Format\Tar::compressDirZst()

• File: private/lib/Format/Tar.php
• Params:
• string $sourceDir Absolute path to the source directory.
• string $outputPath Absolute path where the .tar.zst file should be written.

Raven\Lib\Format\Tar::compressPath()

• File: private/lib/Format/Tar.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $outputPath Absolute path where the \.tar\ file should be written.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Tar::compressPathBz2()

• File: private/lib/Format/Tar.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $outputPath Absolute path where the \.tar.bz2\ file should be written.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Tar::compressPathGz()

• File: private/lib/Format/Tar.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $outputPath Absolute path where the \.tar.gz\ file should be written.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Tar::compressPathXz()

• File: private/lib/Format/Tar.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $outputPath Absolute path where the \.tar.xz\ file should be written.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Tar::compressPathZst()

• File: private/lib/Format/Tar.php
• Params:
• string $sourcePath Absolute path to the source file or directory.
• string $outputPath Absolute path where the \.tar.zst\ file should be written.
• string|null $entryName Optional archive-internal root name override.

Raven\Lib\Format\Tar::extractDir()

• File: private/lib/Format/Tar.php
• Params:
• string $archivePath Absolute path to the \.tar\ or \.tar.gz\ file.
• string $entryName TAR-internal directory path to extract.
• string $targetDir Absolute path that should receive the directory contents.

Raven\Lib\Format\Tar::extractFile()

• File: private/lib/Format/Tar.php
• Params:
• string $archivePath Absolute path to the .tar or .tar.gz file.
• string $entryName TAR-internal entry name to extract.
• string $targetPath Absolute path where the extracted file should land.

Raven\Lib\Format\Tar::extractTo()

• File: private/lib/Format/Tar.php
• Params:
• string $archivePath Absolute path to the .tar or .tar.gz file.
• string $targetDir Absolute path to the destination directory.
• string|null $subDir Optional sub-directory inside the archive to

Raven\Lib\Format\Tar::int()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::listEntries()

• File: private/lib/Format/Tar.php
• Params:
• string $archivePath Absolute path to the .tar or .tar.gz file.

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Tar::string()

• File: private/lib/Format/Tar.php
• Params: (none)

Raven\Lib\Format\Txt::read()

• File: private/lib/Format/Txt.php
• Params:
• string $path Absolute file path.

Raven\Lib\Format\Txt::write()

• File: private/lib/Format/Txt.php
• Params:
• string $path Absolute file path.
• string $content Text content to persist.
• int|null $mode Optional chmod applied after a successful write.

Raven\Lib\Format\Xz::__construct()

• File: private/lib/Format/Xz.php
• Params:
• string $binary Path to the xz binary; defaults to \xz\ (resolved from PATH).

Raven\Lib\Format\Xz::compress()

• File: private/lib/Format/Xz.php
• Params:
• string $sourcePath Absolute path to the uncompressed source file.
• string $targetPath Absolute path where the .xz output should land.
• int $level Compression level 0 (fast) to 9 (best); default 6.

Raven\Lib\Format\Xz::decompress()

• File: private/lib/Format/Xz.php
• Params:
• string $sourcePath Absolute path to the .xz compressed file.
• string $targetPath Absolute path where the decompressed output should land.

Raven\Lib\Format\Xz::isAvailable()

• File: private/lib/Format/Xz.php
• Params: (none)

Raven\Lib\Format\Zip::isAvailable()

• File: private/lib/Format/Zip.php
• Params: (none)

Raven\Lib\Format\Zst::__construct()

• File: private/lib/Format/Zst.php
• Params:
• string $binary Path to the zstd binary; defaults to \zstd\ (resolved from PATH).

Raven\Lib\Format\Zst::compress()

• File: private/lib/Format/Zst.php
• Params:
• string $sourcePath Absolute path to the uncompressed source file.
• string $targetPath Absolute path where the .zst output should land.
• int $level Compression level 1 (fast) to 19 (best); default 3.

Raven\Lib\Format\Zst::decompress()

• File: private/lib/Format/Zst.php
• Params:
• string $sourcePath Absolute path to the .zst compressed file.
• string $targetPath Absolute path where the decompressed output should land.

Raven\Lib\Format\Zst::isAvailable()

• File: private/lib/Format/Zst.php
• Params: (none)

writeExtractedEntry()

• File: private/lib/Format/Zip.php
• Params:
• string $targetPath Absolute output path.
• string $contents Extracted file contents.
• string $label Human-readable archive label for errors.