Library Group: archive
Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.
| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| Raven\Lib\Archive\Compress::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Compress::addPath() | method | Adds or replaces one file or directory inside an existing archive. | void |
| Raven\Lib\Archive\Compress::compressDir() | method | Compresses a source directory into one archive file chosen by output suffix. | void |
| Raven\Lib\Archive\Compress::compressPath() | method | Compresses a source file or directory into one archive file chosen by suffix. | void |
| Raven\Lib\Archive\Compress::dirFormats() | method | Returns supported multi-file archive extensions for directory compression. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Compress::fileFormats() | method | Returns supported single-file compression extensions. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Compress::formats() | method | Returns every archive extension supported by the shared compression surface. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Compress::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Compress::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Compress::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Compress::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Compress::supports() | method | Returns true when the output filename uses any supported archive suffix. | bool True when compressPath() can handle the requested format. |
| Raven\Lib\Archive\Compress::supportsDir() | method | Returns true when the output filename uses a supported directory-archive suffix. | bool True when compressDir() can handle the requested format. |
| Raven\Lib\Archive\Extract::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::extract() | method | Extracts one full archive payload to a target path across all supported formats. | void |
| Raven\Lib\Archive\Extract::extractDir() | method | Extracts one named archive directory into a target directory. | void |
| Raven\Lib\Archive\Extract::extractFile() | method | Extracts one named archive entry to a target file path. | void |
| Raven\Lib\Archive\Extract::extractTo() | method | Extracts a supported archive package into a target directory. | void |
| Raven\Lib\Archive\Extract::listEntries() | method | Returns all entry names in a supported package archive. | array<int, string> Normalized archive-internal entry names. |
| Raven\Lib\Archive\Extract::manifestSlug() | method | Reads a slug value from an archive manifest at root or one wrapper level deep. | string\|null Valid slug string, or null when no candidate manifest matches. |
| Raven\Lib\Archive\Extract::packageAccept() | method | Returns an HTML file-input accept value for supported package archives. | string Comma-delimited accept attribute value. |
| Raven\Lib\Archive\Extract::packageExtensions() | method | Returns supported package-archive extensions for install/import workflows. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Extract::supportsPackage() | method | Returns true when the filename uses a supported package-archive suffix. | bool True when Raven can extract the package. |
| Raven\Lib\Archive\Folder::create() | method | Creates one direct child directory and applies the requested mode. | bool True when the directory was created successfully. |
| Raven\Lib\Archive\Folder::ensure() | method | Ensures one directory exists and applies the requested mode. | bool True when the directory exists after the call. |
| Raven\Lib\Archive\Folder::removeEmpty() | method | Removes one empty directory. | bool True when the directory was removed or already absent. |
| Raven\Lib\Archive\Folder::removeTree() | method | Removes a directory and all of its contents recursively. | void |
| Raven\Lib\Archive\Install::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Install::extensionSlug() | method | Reads an extension directory slug from an uploaded archive manifest. | string\|null Valid extension slug, or null when none can be resolved. |
| Raven\Lib\Archive\Install::extractTo() | method | Extracts an uploaded archive into a target directory and validates non-empty output. | string\|null Null on success, or one human-facing error message. |
| Raven\Lib\Archive\Install::flattenRoot() | method | Normalizes extracted package layout when the archive uses one top-level wrapper directory. | string\|null Null on success, or one human-facing error message. |
| Raven\Lib\Archive\Install::resolveInstallName() | method | Resolves one final install name from manual input, archive metadata, and collision rules. | array{ |
| Raven\Lib\Archive\Install::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Install::themeSlug() | method | Reads a public-theme slug from an uploaded archive manifest. | string\|null Valid theme slug, or null when none can be resolved. |
| Raven\Lib\Archive\Install::validateUpload() | method | Validates one uploaded archive payload for a theme/extension install flow. | array{ok: bool, error?: string, tmppath?: string, archivename?: string} |
| Raven\Lib\Archive\Package::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Package::accept() | method | Returns an HTML file-input accept value for supported package archives. | string Comma-delimited accept attribute value. |
| Raven\Lib\Archive\Package::downloadName() | method | Returns one browser-facing download filename for an archive export. | string Browser-facing archive filename. |
| Raven\Lib\Archive\Package::exportDir() | method | Builds an archive from a source directory and returns export metadata. | array{path: string, format: string, suffix: string, mime_type: string} Export metadata. |
| Raven\Lib\Archive\Package::exportFormatOptions() | method | Returns export format options keyed by canonical archive format value. | array<string, string> Canonical format key => human-facing label. |
| Raven\Lib\Archive\Package::exportFormats() | method | Returns supported directory-export archive extensions. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Package::extensions() | method | Returns supported package-archive extensions for upload/import workflows. | array<int, string> Lowercase extension list without leading dots. |
| Raven\Lib\Archive\Package::extractUpload() | method | Extracts an uploaded archive package into the target directory. | void |
| Raven\Lib\Archive\Package::formatLabels() | method | Returns human-facing package upload format labels for panel help text. | array<int, string> Display labels without leading dots. |
| Raven\Lib\Archive\Package::hasFiles() | method | Returns true when a directory contains at least one non-dot entry. | bool True when the directory exists and is not empty. |
| Raven\Lib\Archive\Package::manifestSlug() | method | Reads a slug value from one manifest file inside a supported package archive. | string\|null Valid slug string, or null when none can be resolved. |
| Raven\Lib\Archive\Package::mimeType() | method | Returns the HTTP content type Raven should send for one archive format. | string Response content type. |
| Raven\Lib\Archive\Package::streamDownload() | method | Streams one local file as a download response, then deletes it. | void |
| Raven\Lib\Archive\Package::supports() | method | Returns true when one filename uses a supported package-archive suffix. | bool True when Raven can extract the package. |
| Raven\Lib\Archive\Package::uploadErrorMessage() | method | Returns one human-facing upload error message for a package archive input. | string Human-facing error message. |
| Raven\Lib\Archive\Update::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Update::bool() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Update::compare() | method | Compares the local revision against the remote source and returns state info. | array<string, mixed> Comparison result with local/remote state and comparison details. |
| Raven\Lib\Archive\Update::dryRun() | method | Performs a dry run against the remote source and returns a planned action list. | array<string, mixed> Dry-run result with planned actions and summary. |
| Raven\Lib\Archive\Update::int() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Update::update() | method | Applies the update plan from the remote source to the local tree. | array<string, mixed> Update result with applied action count and final state. |
| Raven\Lib\Archive\Upstream::__construct() | method | (No summary.) | (No @return.) |
| Raven\Lib\Archive\Upstream::defaults() | method | Returns the factory-default update source settings. | array{mode: string, githubrepo: string, repourl: string, sourceurl: string, sourcelabel: string} |
| Raven\Lib\Archive\Upstream::fromConfig() | method | Resolves update source settings from the live runtime config array. | array{mode: string, githubrepo: string, repourl: string, sourceurl: string, sourcelabel: string} |
| Raven\Lib\Archive\Upstream::fromPost() | method | Resolves update source settings from a POST payload, falling back to a prior resolved source. | array{mode: string, githubrepo: string, repourl: string, sourceurl: string, sourcelabel: string} |
| Raven\Lib\Archive\Upstream::validationErrors() | method | Returns a list of human-readable validation errors for a resolved source array. | array<int, string> List of error strings; empty if valid. |
Parameter Details
Raven\Lib\Archive\Compress::__construct()
- File:
private/lib/Archive/Compress.php - Params:
Zip|null $zip ZIP archive handler override for tests/composition.Tar|null $tar TAR archive handler override for tests/composition.Szip|null $szip 7-Zip archive handler override for tests/composition.Gz|null $gz Gzip compression handler override for tests/composition.Bz2|null $bz2 Bzip2 compression handler override for tests/composition.Xz|null $xz XZ compression handler override for tests/composition.Zst|null $zst Zstandard compression handler override for tests/composition.
Raven\Lib\Archive\Compress::addPath()
- File:
private/lib/Archive/Compress.php - Params:
string $archivePath Absolute path to the archive being modified.string $sourcePath Absolute path to the file or directory to add.string $entryName Archive-internal destination path.
Raven\Lib\Archive\Compress::compressDir()
- File:
private/lib/Archive/Compress.php - Params:
string $sourceDir Absolute path to the source directory.string $archiveRoot Preferred archive root wrapper name where supported.string $outputPath Absolute output archive path.
Raven\Lib\Archive\Compress::compressPath()
- File:
private/lib/Archive/Compress.php - Params:
string $sourcePath Absolute path to the source file or directory.string $archiveRoot Preferred archive-internal root name where supported.string $outputPath Absolute output archive path.
Raven\Lib\Archive\Compress::dirFormats()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::fileFormats()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::formats()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::string()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::string()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::string()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::string()
- File:
private/lib/Archive/Compress.php - Params:
(none)
Raven\Lib\Archive\Compress::supports()
- File:
private/lib/Archive/Compress.php - Params:
string $filename Output filename or archive path to inspect.
Raven\Lib\Archive\Compress::supportsDir()
- File:
private/lib/Archive/Compress.php - Params:
string $filename Output filename or archive path to inspect.
Raven\Lib\Archive\Extract::__construct()
- File:
private/lib/Archive/Extract.php - Params:
Zip|null $zip ZIP archive handler override for tests/composition.Tar|null $tar TAR archive handler override for tests/composition.Szip|null $szip 7-Zip archive handler override for tests/composition.Gz|null $gz Gzip decompression handler override for tests/composition.Bz2|null $bz2 Bzip2 decompression handler override for tests/composition.Xz|null $xz XZ decompression handler override for tests/composition.Zst|null $zst Zstandard decompression handler override for tests/composition.
Raven\Lib\Archive\Extract::extract()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string $targetPath Absolute output directory or file path.
Raven\Lib\Archive\Extract::extractDir()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string $entryName Archive-internal directory path to extract.string $targetDir Absolute output directory for the extracted contents.
Raven\Lib\Archive\Extract::extractFile()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string $entryName Archive-internal path to extract.string $targetPath Absolute output path for the extracted file.string|null $archiveName Original client filename used when the PHP temporary path has no suffix.
Raven\Lib\Archive\Extract::extractTo()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string $targetDir Absolute path to the destination directory.string|null $archiveName Original client filename used when the PHP temporary path has no suffix.
Raven\Lib\Archive\Extract::listEntries()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string|null $archiveName Original client filename used when the PHP temporary path has no suffix.
Raven\Lib\Archive\Extract::manifestSlug()
- File:
private/lib/Archive/Extract.php - Params:
string $archivePath Absolute path to the source archive.string $manifestFilename Manifest basename to search for.int $maxSlugLength Maximum slug length allowed by the caller.string|null $archiveName Original client filename used when the PHP temporary path has no suffix.
Raven\Lib\Archive\Extract::packageAccept()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::packageExtensions()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::string()
- File:
private/lib/Archive/Extract.php - Params:
(none)
Raven\Lib\Archive\Extract::supportsPackage()
- File:
private/lib/Archive/Extract.php - Params:
string $filename Uploaded/archive filename to inspect.
Raven\Lib\Archive\Folder::create()
- File:
private/lib/Archive/Folder.php - Params:
string $directory Absolute directory path.int $mode Octal directory mode to apply.
Raven\Lib\Archive\Folder::ensure()
- File:
private/lib/Archive/Folder.php - Params:
string $directory Absolute directory path.int $mode Octal directory mode to enforce.
Raven\Lib\Archive\Folder::removeEmpty()
- File:
private/lib/Archive/Folder.php - Params:
string $directory Absolute directory path.
Raven\Lib\Archive\Folder::removeTree()
- File:
private/lib/Archive/Folder.php - Params:
string $directory Absolute path to the directory to remove.
Raven\Lib\Archive\Install::__construct()
- File:
private/lib/Archive/Install.php - Params:
InputSanitizer $input Shared text/path normalization helper.Upload $uploads Shared upload validation policy.Package $archives Shared archive package helper surface.
Raven\Lib\Archive\Install::extensionSlug()
- File:
private/lib/Archive/Install.php - Params:
string $tmpPath Absolute path to the uploaded temporary archive.string|null $archiveName Original client filename used for archive-type detection.
Raven\Lib\Archive\Install::extractTo()
- File:
private/lib/Archive/Install.php - Params:
string $tmpPath Absolute path to the uploaded temporary archive.string $targetDirectory Absolute target directory.callable(string): void $cleanup Cleanup callback for failed extraction.string $entityLabel Human-facing entity label for fallback errors.string|null $archiveName Original client filename used for archive-type detection.
Raven\Lib\Archive\Install::flattenRoot()
- File:
private/lib/Archive/Install.php - Params:
string $targetDirectory Absolute extraction target directory.
Raven\Lib\Archive\Install::resolveInstallName()
- File:
private/lib/Archive/Install.php - Params:
string $requestedName Manual slug/directory override from the operator.string $archiveName Original uploaded archive filename.callable(string): ?string $deriveFromArchive Archive-derived fallback name resolver.callable(string): bool $isSafeName Name validator for the target collection.callable(string): bool $isReservedName Reserved-name guard for stock items.callable(string): ?string $nextAvailableName Auto-rename resolver for slug collisions.callable(string): bool $pathExists Filesystem existence probe for the target name.string $entityName Human-facing entity label.string $safeNameRequirement Human-facing validation error for unsafe names.
Raven\Lib\Archive\Install::string()
- File:
private/lib/Archive/Install.php - Params:
(none)
Raven\Lib\Archive\Install::themeSlug()
- File:
private/lib/Archive/Install.php - Params:
string $tmpPath Absolute path to the uploaded temporary archive.string|null $archiveName Original client filename used for archive-type detection.
Raven\Lib\Archive\Install::validateUpload()
- File:
private/lib/Archive/Install.php - Params:
mixed $rawUpload Raw \$_FILES[...]\node.string $packageLabel Human-facing package label.string $collectionLabel Human-facing collection label used in errors.int $maxArchiveBytes Maximum allowed archive size in bytes.
Raven\Lib\Archive\Package::__construct()
- File:
private/lib/Archive/Package.php - Params:
string $projectRoot Absolute Raven project root path.Extract|null $extract Archive extraction forwarder override for tests/composition.Compress|null $compress Archive compression forwarder override for tests/composition.
Raven\Lib\Archive\Package::accept()
- File:
private/lib/Archive/Package.php - Params:
(none)
Raven\Lib\Archive\Package::downloadName()
- File:
private/lib/Archive/Package.php - Params:
string $prefix Download filename stem without timestamp or suffix.string $format Archive format key such as \zip\or \tar.gz\.string|null $timestamp Optional preformatted timestamp; null uses current UTC time.
Raven\Lib\Archive\Package::exportDir()
- File:
private/lib/Archive/Package.php - Params:
string $sourceDirectory Absolute path to the source directory.string $archiveRoot Preferred archive-root folder name inside the archive.string $format Requested archive format key.
Raven\Lib\Archive\Package::exportFormatOptions()
- File:
private/lib/Archive/Package.php - Params:
(none)
Raven\Lib\Archive\Package::exportFormats()
- File:
private/lib/Archive/Package.php - Params:
(none)
Raven\Lib\Archive\Package::extensions()
- File:
private/lib/Archive/Package.php - Params:
(none)
Raven\Lib\Archive\Package::extractUpload()
- File:
private/lib/Archive/Package.php - Params:
string $tmpPath Absolute path to the uploaded temporary archive file.string $targetDirectory Absolute extraction target directory.string|null $archiveName Original client filename used for archive-type detection.
Raven\Lib\Archive\Package::formatLabels()
- File:
private/lib/Archive/Package.php - Params:
(none)
Raven\Lib\Archive\Package::hasFiles()
- File:
private/lib/Archive/Package.php - Params:
string $directory Absolute directory path to inspect.
Raven\Lib\Archive\Package::manifestSlug()
- File:
private/lib/Archive/Package.php - Params:
string $archivePath Absolute path to the source archive.string $manifestFilename Manifest basename such as \ext.json\or \theme.json\.int $maxSlugLength Maximum allowed slug length.string|null $archiveName Original client filename used for archive-type detection.
Raven\Lib\Archive\Package::mimeType()
- File:
private/lib/Archive/Package.php - Params:
string $format Archive format key.
Raven\Lib\Archive\Package::streamDownload()
- File:
private/lib/Archive/Package.php - Params:
string $path Absolute path to the local archive/download file.string $downloadFilename Browser-facing download filename.string $contentType HTTP content type for the response.
Raven\Lib\Archive\Package::supports()
- File:
private/lib/Archive/Package.php - Params:
string $filename Uploaded/archive filename to inspect.
Raven\Lib\Archive\Package::uploadErrorMessage()
- File:
private/lib/Archive/Package.php - Params:
int $code PHP upload error code.string $packageLabel Human-facing package label (e.g. \Theme archive\).
Raven\Lib\Archive\Update::__construct()
- File:
private/lib/Archive/Update.php - Params:
string $root Absolute Raven project root path.Git $git Git command runner instance.array<int, string> $stockThemeSlugs Slugs of stock themes to protect from deletion.array<int, string> $stockExtensionDirectories Directory names of stock extensions to protect.
Raven\Lib\Archive\Update::bool()
- File:
private/lib/Archive/Update.php - Params:
(none)
Raven\Lib\Archive\Update::compare()
- File:
private/lib/Archive/Update.php - Params:
array{
Raven\Lib\Archive\Update::dryRun()
- File:
private/lib/Archive/Update.php - Params:
array{bool $allowOverwrite Whether to suppress the blocked-count warning when local files differ.
Raven\Lib\Archive\Update::int()
- File:
private/lib/Archive/Update.php - Params:
(none)
Raven\Lib\Archive\Update::update()
- File:
private/lib/Archive/Update.php - Params:
array{bool $allowOverwrite Whether to allow overwriting locally modified managed files.
Raven\Lib\Archive\Upstream::__construct()
- File:
private/lib/Archive/Upstream.php - Params:
InputSanitizer $input Input sanitizer for repo/URL fields.
Raven\Lib\Archive\Upstream::defaults()
- File:
private/lib/Archive/Upstream.php - Params:
(none)
Raven\Lib\Archive\Upstream::fromConfig()
- File:
private/lib/Archive/Upstream.php - Params:
array<string, mixed> $config Full runtime config array.
Raven\Lib\Archive\Upstream::fromPost()
- File:
private/lib/Archive/Upstream.php - Params:
array<string, mixed> $post Raw POST payload from the update settings form.array{mode: string, github_repo: string, repo_url: string, source_url?: string, source_label?: string} $fallback Previously resolved source to fall back to for missing fields.
Raven\Lib\Archive\Upstream::validationErrors()
- File:
private/lib/Archive/Upstream.php - Params:
array{mode: string, github_repo: string, repo_url: string, source_url?: string, source_label?: string} $source Resolved update source settings.