The Phar class

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Introduction

The Phar class provides a high-level interface to accessing and creating phar archives.

Class synopsis

constintBZ2;
constintGZ;
constintNONE;
constintPHAR;
constintTAR;
constintZIP;
constintPHP;
constintPHPS;
constintMD5;
constintSHA1;
constintSHA256;
constintSHA512;
public__construct(string$filename, int$flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string$alias = null)
publicaddEmptyDir(string$directory): void
publicaddFile(string$filename, ?string$localName = null): void
publicaddFromString(string$localName, string$contents): void
finalpublicstaticapiVersion(): string
publicbuildFromDirectory(string$directory, string$pattern = ""): array
publicbuildFromIterator(Traversable$iterator, ?string$baseDirectory = null): array
finalpublicstaticcanCompress(int$compression = 0): bool
finalpublicstaticcanWrite(): bool
publiccompress(int$compression, ?string$extension = null): ?Phar
publiccompressFiles(int$compression): void
publicconvertToData(?int$format = null, ?int$compression = null, ?string$extension = null): ?PharData
publicconvertToExecutable(?int$format = null, ?int$compression = null, ?string$extension = null): ?Phar
publiccopy(string$from, string$to): bool
publiccount(int$mode = COUNT_NORMAL): int
finalpublicstaticcreateDefaultStub(?string$index = null, ?string$webIndex = null): string
publicdecompress(?string$extension = null): ?Phar
publicdelMetadata(): bool
publicdelete(string$localName): bool
publicextractTo(string$directory, array|string|null$files = null, bool$overwrite = false): bool
publicgetAlias(): ?string
publicgetMetadata(array$unserializeOptions = []): mixed
publicgetModified(): bool
publicgetPath(): string
publicgetStub(): string
finalpublicstaticgetSupportedCompression(): array
finalpublicstaticgetSupportedSignatures(): array
publichasMetadata(): bool
finalpublicstaticinterceptFileFuncs(): void
publicisBuffering(): bool
publicisFileFormat(int$format): bool
finalpublicstaticisValidPharFilename(string$filename, bool$executable = true): bool
publicisWritable(): bool
finalpublicstaticloadPhar(string$filename, ?string$alias = null): bool
finalpublicstaticmapPhar(?string$alias = null, int$offset = 0): bool
finalpublicstaticmount(string$pharPath, string$externalPath): void
finalpublicstaticmungServer(array$variables): void
publicoffsetExists(string$localName): bool
publicoffsetGet(string$localName): SplFileInfo
publicoffsetSet(string$localName, resource|string$value): void
publicoffsetUnset(string$localName): void
finalpublicstaticrunning(bool$returnPhar = true): string
publicsetAlias(string$alias): bool
publicsetDefaultStub(?string$index = null, ?string$webIndex = null): bool
publicsetMetadata(mixed$metadata): void
publicsetSignatureAlgorithm(int$algo, ?string$privateKey = null): void
publicsetStub(resource|string$stub, int$length = -1): bool
finalpublicstaticunlinkArchive(string$filename): bool
finalpublicstaticwebPhar(
    ?string$alias = null,
    ?string$index = null,
    ?string$fileNotFoundScript = null,
    array$mimeTypes = [],
    ?callable$rewrite = null
): void
public__destruct()
publicSplFileInfo::openFile(string$mode = "r", bool$useIncludePath = false, ?resource$context = null): SplFileObject
publicSplFileInfo::setFileClass(string$class = SplFileObject::class): void
publicSplFileInfo::setInfoClass(string$class = SplFileInfo::class): void
}

Table of Contents

To Top