The PharData class

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

    Introduction

    The PharData class provides a high-level interface to accessing and creating non-executable tar and zip archives. Because these archives do not contain a stub and cannot be executed by the phar extension, it is possible to create and manipulate regular zip and tar files using the PharData class even if phar.readonly php.ini setting is 1.

    Class synopsis

    classPharDataextendsRecursiveDirectoryIteratorimplementsCountable, ArrayAccess {
    publicconstintFilesystemIterator::CURRENT_MODE_MASK;
    publicconstintFilesystemIterator::CURRENT_AS_PATHNAME;
    publicconstintFilesystemIterator::CURRENT_AS_FILEINFO;
    publicconstintFilesystemIterator::CURRENT_AS_SELF;
    publicconstintFilesystemIterator::KEY_MODE_MASK;
    publicconstintFilesystemIterator::KEY_AS_PATHNAME;
    publicconstintFilesystemIterator::FOLLOW_SYMLINKS;
    publicconstintFilesystemIterator::KEY_AS_FILENAME;
    publicconstintFilesystemIterator::NEW_CURRENT_AND_KEY;
    publicconstintFilesystemIterator::OTHER_MODE_MASK;
    publicconstintFilesystemIterator::SKIP_DOTS;
    publicconstintFilesystemIterator::UNIX_PATHS;
    public__construct(
        string$filename,
        int$flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS,
        ?string$alias = null,
        int$format = 0
    )
    publicaddEmptyDir(string$directory): void
    publicaddFile(string$filename, ?string$localName = null): void
    publicaddFromString(string$localName, string$contents): void
    publicbuildFromDirectory(string$directory, string$pattern = ""): array
    publicbuildFromIterator(Traversable$iterator, ?string$baseDirectory = null): array
    publiccompress(int$compression, ?string$extension = null): ?PharData
    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
    publicdecompress(?string$extension = null): ?PharData
    publicdecompressFiles(): bool
    publicdelMetadata(): bool
    publicdelete(string$localName): bool
    publicextractTo(string$directory, array|string|null$files = null, bool$overwrite = false): bool
    publicisWritable(): bool
    publicoffsetSet(string$localName, resource|string$value): void
    publicoffsetUnset(string$localName): void
    publicsetAlias(string$alias): bool
    publicsetDefaultStub(?string$index = null, ?string$webIndex = null): bool
    publicsetMetadata(mixed$metadata): void
    publicsetSignatureAlgorithm(int$algo, ?string$privateKey = null): void
    publicsetStub(string$stub, int$len = -1): bool
    public__destruct()
    publicRecursiveDirectoryIterator::getChildren(): RecursiveDirectoryIterator
    publicRecursiveDirectoryIterator::getSubPath(): string
    publicRecursiveDirectoryIterator::getSubPathname(): string
    publicRecursiveDirectoryIterator::hasChildren(bool$allowLinks = false): bool
    publicRecursiveDirectoryIterator::key(): string
    publicRecursiveDirectoryIterator::next(): void
    publicRecursiveDirectoryIterator::rewind(): void
    publicFilesystemIterator::current(): string|SplFileInfo|FilesystemIterator
    publicFilesystemIterator::getFlags(): int
    publicFilesystemIterator::key(): string
    publicFilesystemIterator::next(): void
    publicFilesystemIterator::rewind(): void
    publicFilesystemIterator::setFlags(int$flags): void
    publicDirectoryIterator::current(): mixed
    publicDirectoryIterator::getBasename(string$suffix = ""): string
    publicDirectoryIterator::getExtension(): string
    publicDirectoryIterator::getFilename(): string
    publicDirectoryIterator::isDot(): bool
    publicDirectoryIterator::key(): mixed
    publicDirectoryIterator::next(): void
    publicDirectoryIterator::rewind(): void
    publicDirectoryIterator::seek(int$offset): void
    publicDirectoryIterator::__toString(): string
    publicDirectoryIterator::valid(): bool
    publicSplFileInfo::getATime(): int|false
    publicSplFileInfo::getBasename(string$suffix = ""): string
    publicSplFileInfo::getCTime(): int|false
    publicSplFileInfo::getExtension(): string
    publicSplFileInfo::getFileInfo(?string$class = null): SplFileInfo
    publicSplFileInfo::getFilename(): string
    publicSplFileInfo::getGroup(): int|false
    publicSplFileInfo::getInode(): int|false
    publicSplFileInfo::getLinkTarget(): string|false
    publicSplFileInfo::getMTime(): int|false
    publicSplFileInfo::getOwner(): int|false
    publicSplFileInfo::getPath(): string
    publicSplFileInfo::getPathInfo(?string$class = null): ?SplFileInfo
    publicSplFileInfo::getPathname(): string
    publicSplFileInfo::getPerms(): int|false
    publicSplFileInfo::getRealPath(): string|false
    publicSplFileInfo::getSize(): int|false
    publicSplFileInfo::getType(): string|false
    publicSplFileInfo::isDir(): bool
    publicSplFileInfo::isExecutable(): bool
    publicSplFileInfo::isFile(): bool
    publicSplFileInfo::isLink(): bool
    publicSplFileInfo::isReadable(): bool
    publicSplFileInfo::isWritable(): bool
    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
    publicSplFileInfo::__toString(): string
    }

    Table of Contents

    To Top