PHP: Phar - Manual (original) (raw)

class **Phar extends RecursiveDirectoryIterator implements Countable,ArrayAccess {

/* Inherited constants */

public const int FilesystemIterator::CURRENT_MODE_MASK;

public const int FilesystemIterator::CURRENT_AS_PATHNAME;

public const int FilesystemIterator::CURRENT_AS_FILEINFO;

public const int FilesystemIterator::CURRENT_AS_SELF;

public const int FilesystemIterator::KEY_MODE_MASK;

public const int FilesystemIterator::KEY_AS_PATHNAME;

public const int FilesystemIterator::FOLLOW_SYMLINKS;

public const int FilesystemIterator::KEY_AS_FILENAME;

public const int FilesystemIterator::NEW_CURRENT_AND_KEY;

public const int FilesystemIterator::OTHER_MODE_MASK;

public const int FilesystemIterator::SKIP_DOTS;

public const int FilesystemIterator::UNIX_PATHS;

/* Constants */

const int BZ2;

const int GZ;

const int NONE;

const int PHAR;

const int TAR;

const int ZIP;

const int COMPRESSED;

const int PHP;

const int PHPS;

const int MD5;

const int OPENSSL;

const int OPENSSL_SHA256;

const int OPENSSL_SHA512;

const int SHA1;

const int SHA256;

const int SHA512;

/* Methods */

public __construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string $alias = [null](reserved.constants.php#constant.null))

public addEmptyDir(string $directory): void

public addFile(string $filename, ?string $localName = [null](reserved.constants.php#constant.null)): void

public addFromString(string $localName, string $contents): void

final public static apiVersion(): string

public buildFromDirectory(string $directory, string $pattern = ""): array

public buildFromIterator(Traversable $iterator, ?string $baseDirectory = [null](reserved.constants.php#constant.null)): array

final public static canCompress(int $compression = 0): bool

final public static canWrite(): bool

public compress(int $compression, ?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public compressFiles(int $compression): void

public convertToData(?int $format = [null](reserved.constants.php#constant.null), ?int $compression = [null](reserved.constants.php#constant.null), ?string $extension = [null](reserved.constants.php#constant.null)): ?PharData

public convertToExecutable(?int $format = [null](reserved.constants.php#constant.null), ?int $compression = [null](reserved.constants.php#constant.null), ?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public copy(string $from, string $to): true

public count(int $mode = [COUNT_NORMAL](array.constants.php#constant.count-normal)): int

final public static createDefaultStub(?string $index = [null](reserved.constants.php#constant.null), ?string $webIndex = [null](reserved.constants.php#constant.null)): string

public decompress(?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public decompressFiles(): true

public delMetadata(): true

public delete(string $localName): true

public extractTo(string $directory, array|string|null $files = [null](reserved.constants.php#constant.null), bool $overwrite = [false](reserved.constants.php#constant.false)): bool

public getAlias(): ?string

public getMetadata(array $unserializeOptions = []): mixed

public getModified(): bool

public getPath(): string

public getSignature(): array|false

public getStub(): string

final public static getSupportedCompression(): array

final public static getSupportedSignatures(): array

public getVersion(): string

public hasMetadata(): bool

final public static interceptFileFuncs(): void

public isBuffering(): bool

public isCompressed(): int|false

public isFileFormat(int $format): bool

final public static isValidPharFilename(string $filename, bool $executable = [true](reserved.constants.php#constant.true)): bool

public isWritable(): bool

final public static loadPhar(string $filename, ?string $alias = [null](reserved.constants.php#constant.null)): bool

final public static mapPhar(?string $alias = [null](reserved.constants.php#constant.null), int $offset = 0): bool

final public static mount(string $pharPath, string $externalPath): void

final public static mungServer(array $variables): void

public offsetExists(string $localName): bool

public offsetGet(string $localName): SplFileInfo

public offsetSet(string $localName, resource|string $value): void

public offsetUnset(string $localName): void

final public static running(bool $returnPhar = [true](reserved.constants.php#constant.true)): string

public setAlias(string $alias): true

public setDefaultStub(?string $index = [null](reserved.constants.php#constant.null), ?string $webIndex = [null](reserved.constants.php#constant.null)): true

public setMetadata(mixed $metadata): void

public setSignatureAlgorithm(int $algo, ?string $privateKey = [null](reserved.constants.php#constant.null)): void

public setStub(resource|string $stub, int $length = -1): bool

public startBuffering(): void

public stopBuffering(): void

final public static unlinkArchive(string $filename): true

final public static webPhar(
?string $alias = [null](reserved.constants.php#constant.null),
?string $index = [null](reserved.constants.php#constant.null),
?string $fileNotFoundScript = [null](reserved.constants.php#constant.null),
array $mimeTypes = [],
?callable $rewrite = [null](reserved.constants.php#constant.null)
): void

public __destruct()

/* Inherited methods */

public RecursiveDirectoryIterator::getChildren(): RecursiveDirectoryIterator

public RecursiveDirectoryIterator::getSubPath(): string

public RecursiveDirectoryIterator::getSubPathname(): string

public RecursiveDirectoryIterator::hasChildren(bool $allowLinks = [false](reserved.constants.php#constant.false)): bool

public RecursiveDirectoryIterator::key(): string

public RecursiveDirectoryIterator::next(): void

public RecursiveDirectoryIterator::rewind(): void

public FilesystemIterator::current(): string|SplFileInfo|FilesystemIterator

public FilesystemIterator::getFlags(): int

public FilesystemIterator::key(): string

public FilesystemIterator::next(): void

public FilesystemIterator::rewind(): void

public FilesystemIterator::setFlags(int $flags): void

public DirectoryIterator::current(): mixed

public DirectoryIterator::getBasename(string $suffix = ""): string

public DirectoryIterator::getExtension(): string

public DirectoryIterator::getFilename(): string

public DirectoryIterator::isDot(): bool

public DirectoryIterator::key(): mixed

public DirectoryIterator::next(): void

public DirectoryIterator::rewind(): void

public DirectoryIterator::seek(int $offset): void

public DirectoryIterator::__toString(): string

public DirectoryIterator::valid(): bool

public SplFileInfo::getATime(): int|false

public SplFileInfo::getBasename(string $suffix = ""): string

public SplFileInfo::getCTime(): int|false

public SplFileInfo::getExtension(): string

public SplFileInfo::getFileInfo(?string $class = [null](reserved.constants.php#constant.null)): SplFileInfo

public SplFileInfo::getFilename(): string

public SplFileInfo::getGroup(): int|false

public SplFileInfo::getInode(): int|false

public SplFileInfo::getLinkTarget(): string|false

public SplFileInfo::getMTime(): int|false

public SplFileInfo::getOwner(): int|false

public SplFileInfo::getPath(): string

public SplFileInfo::getPathInfo(?string $class = [null](reserved.constants.php#constant.null)): ?SplFileInfo

public SplFileInfo::getPathname(): string

public SplFileInfo::getPerms(): int|false

public SplFileInfo::getRealPath(): string|false

public SplFileInfo::getSize(): int|false

public SplFileInfo::getType(): string|false

public SplFileInfo::isDir(): bool

public SplFileInfo::isExecutable(): bool

public SplFileInfo::isFile(): bool

public SplFileInfo::isLink(): bool

public SplFileInfo::isReadable(): bool

public SplFileInfo::isWritable(): bool

public SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = [false](reserved.constants.php#constant.false), ?resource $context = [null](reserved.constants.php#constant.null)): SplFileObject

public SplFileInfo::setFileClass(string $class = SplFileObject::class): void

public SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void

public SplFileInfo::__toString(): string

}